Appearance

Get Documents ​

Endpoint ​

http
GET /unified/e-signature/documents/{id}
Integrations supported
  • Adobe Acrobat Sign
  • LinkSquares

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
workflow_id
string

The unique identifier of the workflow.

Required in
  • LinkSquares

Response Body ​

id
string

The unique identifier of the document.

Supported in
  • Adobe Acrobat Sign
  • LinkSquares
name
string

The name of the document.

Supported in
  • Adobe Acrobat Sign
  • LinkSquares
signing_request
object

The signing request associated with the document

id
urls
object[]

The urls of the document

Supported in
  • LinkSquares
url
string

The url of the document

type
string

The type of the url

All possible enum values:
  • view
  • edit
  • public_view
created_by
object

The user who created the document.

Supported in
  • Adobe Acrobat Sign
id
string

The unique identifier of the user.

name
string

The name of the user.

emails
object[]

The emails of the user.

email
string

The email address of the user.

status
string

The status of the document.

Supported in
  • Adobe Acrobat Sign
scope
string

The scope of the document.

Supported in
  • Adobe Acrobat Sign
created_at
string · date-time

The date and time when the document was created.

Supported in
  • Adobe Acrobat Sign
  • LinkSquares
updated_at
string · date-time

The date and time when the document was last updated.

Supported in
  • Adobe Acrobat Sign
last_activity_at
string · date-time

The date and time when the document was last updated.

Supported in
  • Adobe Acrobat Sign
remote_data
object

Raw data returned from the remote API call.