Signature requests API
Signature requests in the Broker & Agent API:
Base URL: https://workspace.brokerandagent.com/api/public/v1. Every call needs an API key or OAuth token.
- List signature requests:
GET /envelopes
List signature requests#
GET /envelopes
Newest first, a page at a time; the same object the
Scope: crm.read
Parameters
| Name | In | Type | |
|---|---|---|---|
status |
query | sent, completed, declined, voided, expired |
|
limit |
query | integer | How many to answer with, 1 to 100. Default 25. |
cursor |
query | string or null | The nextCursor of the page before; absent for the first page. Cut to 200 characters. |
Shell
curl https://workspace.brokerandagent.com/api/public/v1/envelopes \
-H "Authorization: Bearer bak_YOUR_KEY"Responses
| Status | Returns | |
|---|---|---|
200 |
A page of signature requests. | { envelopes: array of Envelope, nextCursor: string or null } |
401 |
No credential, or one that’s unknown, expired or revoked (unauthorized); or the workspace is suspended (workspace_suspended). | |
403 |
The credential lacks the scope (insufficient_scope, naming it in scope), the record isn’t the person’s to change (forbidden), the connection wasn’t granted that workspace (workspace_not_granted), or an assistant-only token called outside the assistant’s tools (wrong_audience). |
|
422 |
A field is the wrong kind or breaks a rule, named in the message (validation); or the Idempotency-Key was used for a different request (idempotency_key_reused). | |
429 |
Too many requests for this credential; wait for Retry-After (rate_limited). |
Something missing or wrong? Email support@brokerandagent.com and