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 provider.

Authentication & access

• Requires a client API token: Authorization: Bearer <token>.
• The caller must hold the contracts.requests.read permission 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

• 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 signing workflow and template version it was built from.
• user_id / business_customer_id — the individual or business subject of the request (mutually exclusive).
• project_id, transaction_id — the associated project and the linked payment transaction, if any.
• status — current overall status of the request.
• current_stage_index, current_participant_key, active_signing_url — the active workflow stage and the participant currently expected to act, with their signing URL when available.
• completed_document_url, audit_log_url — download URLs for the signed document and the Certificate of Signature, available only after all stages complete.
• variables, metadata — variable values applied to the template and any metadata attached to the request.
• participants — a list of every participant with their role, delivery method, signing status, contact details, signing URL, and signing/invitation timestamps.
• completed_at, canceled_at, created_at, updated_at — lifecycle timestamps.

Error responses

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.