Appearance

List Signing requests ​

Endpoint ​

http
GET /unified/e-signature/signing_requests
Integrations supported
  • Adobe Acrobat Sign
  • DocuSign
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Adobe Acrobat Sign
  • DocuSign

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 will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
collections
array

The collections asscoiated with the signing_requests.

Required in
  • DocuSign

Response Body ​

result
object[]

List of Signing requests

id
string

The unique identifier of the signing request.

Supported in
  • Adobe Acrobat Sign
  • DocuSign
name
string

The name of the signing request.

Supported in
  • Adobe Acrobat Sign
  • DocuSign
type
string

The type of the signing request.

Supported in
  • Adobe Acrobat Sign
  • DocuSign
status
string

The status of the signing request.

Supported in
  • Adobe Acrobat Sign
  • DocuSign
collections
object[]

The collections of the signing request.

Supported in
  • DocuSign
id
string

The unique identifier of the collection.

name
string

The name of the collection.

groups
object[]

The groups of the signing request.

Supported in
  • Adobe Acrobat Sign
id
string

The unique identifier of the group.

type
string

The type of the group.

participants
object[]

The participants of the signing request.

Supported in
  • Adobe Acrobat Sign
id
string

The unique identifier of the participant.

name
string

The name of the participant.

emails
object[]

The emails of the participant.

email
string

The email address of the participant.

urls
object[]

The urls of the signing_request

Supported in
  • DocuSign
url
string

The url of the signing_request

type
string

The type of the url

All possible enum values:
  • view
  • edit
  • public_view
created_at
string · date-time

The date and time when the signing request was created.

Supported in
  • DocuSign
updated_at
string · date-time

The date and time when the signing request was last updated.

last_activity_at
string · date-time

The date and time when the signing request was last updated.

expires_on
string · date-time

The date and time when the signing request expires.

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.