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.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
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.readpermission. 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
| Parameter | Type | Default | Constraints | Description |
|---|---|---|---|---|
page | integer | 1 | >= 1 | Page number for pagination. |
page_size | integer | 20 | 1-200 | Number of contract flows per page. |
include_ad_hoc | boolean | false | - | When true, also includes ad-hoc contract flows created by compose-and-send. By default only named, reusable contract flows are returned. |
status | string | - | 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_archived | boolean | false | - | 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 includesid,name,description,template_version_id,status(publishedorarchived),variables,participants,stages,email_notifications,published_at,created_at, andupdated_at.pagination-total,page,page_size, andtotal_pages.
Error responses
| Status | When |
|---|---|
403 | Contract signing is disabled for the client |
422 | page 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.