Get Contract Request

Get contract request

Returns full details for a specific contract signing request, including
current status and signer progress. Returns 404 if it does not exist or
belongs to a different client.

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

Returns full details for a single contract signing request that belongs to your client, including its current overall status, the active signing stage, and per-participant signing progress. This is a read-only lookup; it does not change the request or contact the signing service.

Authentication & access

  • Requires a client API token: Authorization: Bearer <token>.
  • API credentials need the contracts.requests.read permission. 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

  • request_id (string, required) - the ID of the contract request to retrieve. The request must belong to your client; requests owned by another client are treated as not found (404).

Response

200 returns the contract request as a ContractRequestResponse object. Key fields include:

  • id, workflow_id, template_version_id - identifiers for the request and the contract flow and template version it was built from.
  • user_id / business_customer_id - the individual or business subject of the request (mutually exclusive). Set only on requests created with the legacy single-subject fields; requests created with participant_subjects leave them null and each participant carries its own user_id / business_customer_id.
  • project_id, transaction_id - the associated project and the linked payment transaction, if any.
  • status - current overall status of the request: created, awaiting_signature, awaiting_transaction_binding, awaiting_transaction, completed, declined, canceled or expired.
  • current_stage_index, current_participant_key, active_signing_url - the active stage and the participant currently expected to act, with their signing URL while it is their turn to sign.
  • completed_document_url, audit_log_url - download URLs for the signed document and the Certificate of Signature, available only once the request is completed.
  • variables, metadata - variable values applied to the template and any metadata attached to the request.
  • completion_extra_emails - extra addresses that receive the completion notification, beyond the signers.
  • cc_recipients - view-only (CC) recipients, each with email, a read-only view_url (null once the link no longer opens) and view_expires_at (null while signing is in progress).
  • participants - a list of every participant with their role, delivery method, signing status (created, pending, sent, opened, completed, declined, canceled or expired), contact details, signing deadline (expires_at), signing/invitation timestamps, and a signer_url that is returned only while it is that participant's turn to sign.
  • completed_at, canceled_at, created_at, updated_at - lifecycle timestamps.

Error responses

StatusWhen
403Contract signing is disabled for the client
404No contract request with this request_id exists under your 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.

Path Params
string
required
Responses

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