List Workflows

List signing workflows

Returns the signing workflows for the authenticated client. Archived
flows are excluded unless include_archived is true or status=archived
is passed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns a paginated list of contract flows belonging to the authenticated client, ordered by creation time (newest first). Each contract flow describes the template version, participants, stages, default variables, and email-notification settings used when creating contract requests. Archived flows are left out unless you ask for them.

This endpoint is for contract flows (/contracts/workflows). Automation workflows (/workflows) are a different resource.

Authentication & access

  • Requires a client API token: Authorization: Bearer <token>.
  • API credentials need the contracts.workflows.read permission. Dashboard users need the OWNER, OPERATIONS, or DEVELOPER role, or a custom role that includes this permission.
  • Contract signing must be enabled for the client. If it is disabled the request returns 403.

Query parameters

ParameterTypeDefaultConstraintsDescription
pageinteger1>= 1Page number for pagination.
page_sizeinteger201-200Number of contract flows per page.
include_ad_hocbooleanfalse-When true, also includes ad-hoc contract flows created by compose-and-send. By default only named, reusable contract flows are returned.
statusstring-published or archived (draft is also accepted, but no contract flow has that status)Return only contract flows with this status. When set, include_archived is ignored, so status=archived returns only archived flows.
include_archivedbooleanfalse-When true, archived contract flows are returned together with the others. By default they are excluded unless status is given.

Response

200 - Returns a SigningWorkflowListResponse:

  • workflows - array of contract flow objects. Each object includes id, name, description, template_version_id, status (published or archived), variables, participants, stages, email_notifications, published_at, created_at, and updated_at.
  • pagination - total, page, page_size, and total_pages.

Error responses

StatusWhen
403Contract signing is disabled for the client
422page or page_size outside its allowed range, or status is not a valid value

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.

Query Params
integer
≥ 1
Defaults to 1

Page number for pagination

integer
1 to 200
Defaults to 20

Number of items per page

boolean
Defaults to false

Include ad-hoc workflows created by compose-and-send

SigningWorkflowStatus | null

Filter by workflow status

boolean
Defaults to false

Also return archived flows (excluded by default unless status is given)

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json