get
https://api-sandbox.urbanpayx.com/api/v1/contracts/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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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.readpermission 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
| Parameter | Type | Default | Constraints | Description |
|---|---|---|---|---|
page | integer | 1 | >= 1 | Page number for pagination. |
page_size | integer | 20 | 1–200 | Number of workflows per page. |
include_ad_hoc | boolean | false | — | When 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 includesid,name,description,template_version_id,status(draft,published, orarchived),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 this client |
422 | page 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.