Get signing workflow
Returns full details for a specific signing workflow belonging to the
authenticated client. Returns 404 if it does not exist.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Returns the full configuration of a single contract flow that belongs to the authenticated client, looked up by its ID. The response includes the flow's status, the template version it uses, its variable defaults, participant and stage definitions, and per-event email notification settings. Archived flows and ad-hoc flows created by compose-and-send are returned as well.
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.
Path parameters
| Parameter | In | Description |
|---|---|---|
workflow_id | path | ID of the contract flow to retrieve. Must belong to the authenticated client. |
Response
200 - Returns a single contract flow object with these fields:
id- Unique contract flow ID.name- Display name of the contract flow.description- Optional description.template_version_id- ID of the contract template version the flow uses.status- Current status:published(set as soon as the flow is saved) orarchived.variables- Default variable values applied when creating contract requests from this flow.participants- Participant definitions for the flow (key,source,role,field_values,readonly_fields,expire_after_hours).stages- Ordered stage definitions for the flow (index,type,participant,delivery).email_notifications- Per-event email notification toggles, attachment settings,completed_extra_emails,cc_emails, andcc_view_link_days.published_at- Timestamp when the flow was first saved aspublished. Later updates keep this value.created_at- Timestamp when the flow was created.updated_at- Timestamp when the flow was last updated.
Error responses
| Status | When |
|---|---|
403 | Contract signing is disabled for the client |
404 | No contract flow with this ID exists under the authenticated client |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.