Compliance
List contracts
AuthorizationBearer <token>
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Query Parameters
cursor?string
Opaque pagination cursor from meta.cursor.next of the previous page. Do not construct or parse it.
limit?integer
Page size. Values above the maximum are clamped.
Range
1 <= value <= 100Default
25status?string
Filter by contract status.
Value in
- "draft"
- "sent"
- "viewed"
- "partially_signed"
- "signed"
- "countersigned"
- "completed"
- "declined"
- "voided"
- "expired"
- "superseded"
contact_id?string
Filter by contact.
Format
uuidagreement_id?string
Filter by agreement.
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/contracts"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "contract", "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "agreement_id": "67dd069b-637c-4b8e-8d92-17a313d06fb8", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "title": "string", "status": "draft", "content_hash": "string", "signed_hash": "string", "signed_at": "2019-08-24T14:15:22Z", "signer_name": "string", "signer_email": "user@example.com", "document_ref": "string", "expires_at": "2019-08-24T14:15:22Z", "retention_until": "2019-08-24", "signature_source": "portal", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "meta": { "limit": 0, "cursor": { "next": "string", "has_more": true } }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "rate_limited", "message": "Rate limit exceeded. Retry after 7s." }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}