Documents

Envelopes

GET
/v1/workspaces/{workspace_id}/envelopes

The envelopes you can see, as the Documents page lists them: by view, status and free text q, newest activity first.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from /v1/auth/token, or a personal token: opaque, beginning s2a_.

Path Parameters

workspace_id*string

wsp_…, from GET /v1/me

Lengthlength <= 40

Query Parameters

view?string
Default"all"
Value in"all""inbox""waiting""drafts""completed""expiring""favourites""shared""archived"
status?string

Comma-separated, e.g. sent,in_progress

Lengthlength <= 200
q?string
Lengthlength <= 200
page?integer
Range1 <= value <= 9007199254740991
Default1
page_size?integer
Range1 <= value <= 100
Default50

Response Body

One page of envelopes

application/json
  1. response

One page of envelopes

data*array<>
total*integer
Range-9007199254740991 <= value <= 9007199254740991
page*integer
Range-9007199254740991 <= value <= 9007199254740991
page_size*integer
Range-9007199254740991 <= value <= 9007199254740991
curl -X GET 'https://api.sign2approve.com/v1/workspaces/string/envelopes'
{  "data": [    {      "id": "env_01a16d3fd3507be78e41c4540aa20a3c",      "reference": "QUO-0042",      "title": "Quote for Acme",      "status": "sent",      "document_type": "Quote",      "sender": "Sam Sender",      "waiting_on": "Pat Client",      "last_activity_at": "2026-10-24T09:30:00Z",      "sent_at": "2026-10-24T09:30:00Z",      "web_url": "https://app.example.test/w/larkspur/envelopes/01a16d3f-d350-7be7-8e41-c4540aa20a3c"    }  ],  "total": 1,  "page": 1,  "page_size": 50}