Appearance

List Workflows ​

Endpoint ​

http
GET /unified/e-signature/workflows
Integrations supported
  • Adobe Acrobat Sign
  • Ironclad

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_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
template_id
string

The unique identifier of the template.

Supported in
  • Ironclad
status
string

The status of the workflow.

All possible enum values:
  • active
  • cancelled
  • completed
  • draft
  • hidden
  • inactive
  • paused
Enum support by integration
  • Ironclad
    • active
    • completed
    • cancelled
    • paused
Supported in
  • Ironclad

Response Body ​

result
object[]

List of Workflows

id
string

The unique identifier of the workflow.

Supported in
  • Adobe Acrobat Sign
  • Ironclad
name
string

The name of the workflow.

Supported in
  • Adobe Acrobat Sign
  • Ironclad
description
string

The description of the workflow.

Supported in
  • Adobe Acrobat Sign
type
string

The type of the workflow.

Supported in
  • Adobe Acrobat Sign
status
string

The status of the workflow.

All possible enum values:
  • active
  • inactive
  • draft
  • hidden
Supported in
  • Adobe Acrobat Sign
  • Ironclad
created_by
object

The user who created the workflow.

Supported in
  • Adobe Acrobat Sign
  • Ironclad
id
string

The unique identifier of the user.

name
string

The name of the user.

created_at
string · date-time

The date and time when the workflow was created.

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

The date and time when the workflow was last updated.

Supported in
  • Adobe Acrobat Sign
  • Ironclad
stage
object

The stage of the workflow.

Supported in
  • Ironclad
id
string

The unique identifier of the stage.

name
string

The name of the stage.

custom_fields
object

All the custom fields present on the workflow

Supported in
  • Ironclad
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.