get
https://api-sandbox.urbanpayx.com/api/v1/contracts/workflows/
Get signing workflow
Returns full details for a specific signing workflow belonging to the authenticated client.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Returns the full configuration of a single signing workflow that belongs to the authenticated client, looked up by its ID. The response includes the workflow's status, the template version it uses, its variable defaults, participant and stage definitions, and per-event email notification settings.
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. - The client must have contract signing enabled. If the feature is disabled the request returns
403.
Path parameters
| Parameter | In | Description |
|---|---|---|
workflow_id | path | ID of the signing workflow to retrieve. Must belong to the authenticated client. |
Response
200 — Returns a single workflow object with these fields:
id— Unique signing workflow ID.name— Display name of the workflow.description— Optional description.template_version_id— ID of the contract template version the workflow uses.status— Current status:draft,published, orarchived.variables— Default variable values applied when creating contract requests from this workflow.participants— Participant definitions for the workflow.stages— Ordered stage definitions for the workflow.email_notifications— Per-event email notification toggles.published_at— Timestamp when the workflow was published, ornullif it has not been published.created_at— Timestamp when the workflow was created.updated_at— Timestamp when the workflow was last updated.
Error responses
| Status | When |
|---|---|
403 | Contract signing is disabled for this client |
404 | No workflow with this ID exists under the authenticated client |
422 | Path parameter failed validation |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.