List Workflows

List signing workflows

Returns all signing workflows for the authenticated client.

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

Returns a paginated list of signing workflows belonging to the authenticated client, ordered by creation time (newest first). Each workflow describes the template version, participants, stages, default variables, and email-notification settings used when creating contract requests.

Authentication & access

  • Requires a client API token: Authorization: Bearer <token>.
  • The caller must hold the contracts.workflows.read permission and have the OWNER, OPERATIONS, or DEVELOPER role.
  • 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_sizeinteger201200Number of workflows per page.
include_ad_hocbooleanfalseWhen true, also includes ad-hoc workflows created by compose-and-send. By default only named, reusable workflows are returned.

Response

200 — Returns a SigningWorkflowListResponse:

  • workflows — array of workflow objects. Each object includes id, name, description, template_version_id, status (draft, published, or archived), variables, participants, stages, email_notifications, published_at, created_at, and updated_at.
  • paginationtotal, page, page_size, and total_pages.

Error responses

StatusWhen
403Contract signing is disabled for this client
422page or page_size outside its allowed range

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

Responses

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