API reference
Every public operation, generated from the API itself.
One page per operation, each with a playground: put in your token and send the call. Version 0: anything here may change until v1. New here? Start with Getting started.
Try it in the browser
The interactive reference on the API's own host.
Authentication
How an app or a script gets a token.
Authentication
Tokens: OAuth 2.1 with PKCE, client credentials, revocation
| Operation | Method and path |
|---|---|
| Revoke a token | POST /v1/auth/revoke |
| Get tokens | POST /v1/auth/token |
Me
You, your companies and your devices
| Operation | Method and path |
|---|---|
| Who you are | GET /v1/me |
| Your devices | GET /v1/me/devices |
| Sign a device out | DELETE /v1/me/devices/{device_id} |
| Your preferences | GET /v1/me/preferences |
| Change your preferences | PATCH /v1/me/preferences |
Inbox
What waits for you, and what happened
| Operation | Method and path |
|---|---|
| Your activity | GET /v1/workspaces/{workspace_id}/activity |
| Mark activity read | POST /v1/workspaces/{workspace_id}/activity/read |
| Your inbox | GET /v1/workspaces/{workspace_id}/inbox |
| How many are waiting | GET /v1/workspaces/{workspace_id}/inbox/count |
People
The people and groups of a workspace
| Operation | Method and path |
|---|---|
| Departments and groups | GET /v1/workspaces/{workspace_id}/groups |
| People | GET /v1/workspaces/{workspace_id}/people |
| One person | GET /v1/workspaces/{workspace_id}/people/{person_id} |
Approvals
Documents and time off waiting for your decision
| Operation | Method and path |
|---|---|
| Approvals waiting for you | GET /v1/workspaces/{workspace_id}/approvals |
| One approval | GET /v1/workspaces/{workspace_id}/approvals/{approval_id} |
| Approve | POST /v1/workspaces/{workspace_id}/approvals/{approval_id}/approve |
| Decline | POST /v1/workspaces/{workspace_id}/approvals/{approval_id}/decline |
| Ask for changes | POST /v1/workspaces/{workspace_id}/approvals/{approval_id}/request-changes |
Time off
Your leave, balances, the calendar and sickness
| Operation | Method and path |
|---|---|
| Your balances | GET /v1/workspaces/{workspace_id}/timeoff/balances |
| Who’s away | GET /v1/workspaces/{workspace_id}/timeoff/calendar |
| Leave types | GET /v1/workspaces/{workspace_id}/timeoff/leave-types |
| Public holidays | GET /v1/workspaces/{workspace_id}/timeoff/public-holidays |
| Your time off | GET /v1/workspaces/{workspace_id}/timeoff/requests |
| Book time off | POST /v1/workspaces/{workspace_id}/timeoff/requests |
| One request | GET /v1/workspaces/{workspace_id}/timeoff/requests/{request_id} |
| Cancel time off | POST /v1/workspaces/{workspace_id}/timeoff/requests/{request_id}/cancel |
| Preview time off | POST /v1/workspaces/{workspace_id}/timeoff/requests/preview |
| I’m back | POST /v1/workspaces/{workspace_id}/timeoff/sickness/end |
| I’m off sick | POST /v1/workspaces/{workspace_id}/timeoff/sickness/start |
Webhooks
Events sent to your server, signed, with a delivery log
| Operation | Method and path |
|---|---|
| Events | GET /v1/workspaces/{workspace_id}/events |
| Webhooks | GET /v1/workspaces/{workspace_id}/webhooks |
| Subscribe | POST /v1/workspaces/{workspace_id}/webhooks |
| Unsubscribe | DELETE /v1/workspaces/{workspace_id}/webhooks/{webhook_id} |
| One webhook | GET /v1/workspaces/{workspace_id}/webhooks/{webhook_id} |
| Deliveries | GET /v1/workspaces/{workspace_id}/webhooks/{webhook_id}/deliveries |
| Send again | POST /v1/workspaces/{workspace_id}/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver |
| Rotate the secret | POST /v1/workspaces/{workspace_id}/webhooks/{webhook_id}/rotate-secret |
Documents
Envelopes, templates and document types
| Operation | Method and path |
|---|---|
| Document roles | GET /v1/workspaces/{workspace_id}/document-roles |
| Document types | GET /v1/workspaces/{workspace_id}/document-types |
| Envelopes | GET /v1/workspaces/{workspace_id}/envelopes |
| Start an envelope | POST /v1/workspaces/{workspace_id}/envelopes |
| One envelope | GET /v1/workspaces/{workspace_id}/envelopes/{envelope_id} |
| Change a draft | PATCH /v1/workspaces/{workspace_id}/envelopes/{envelope_id} |
| The audit trail | GET /v1/workspaces/{workspace_id}/envelopes/{envelope_id}/audit |
| Remind | POST /v1/workspaces/{workspace_id}/envelopes/{envelope_id}/remind |
| Save as a template | POST /v1/workspaces/{workspace_id}/envelopes/{envelope_id}/save-as-template |
| Send | POST /v1/workspaces/{workspace_id}/envelopes/{envelope_id}/submit |
| Void | POST /v1/workspaces/{workspace_id}/envelopes/{envelope_id}/void |
| Fields | GET /v1/workspaces/{workspace_id}/fields |
| Templates | GET /v1/workspaces/{workspace_id}/templates |
| One template | GET /v1/workspaces/{workspace_id}/templates/{template_id} |
Contacts
The people and companies you send to
| Operation | Method and path |
|---|---|
| Contacts | GET /v1/workspaces/{workspace_id}/contacts |
| Add a contact | POST /v1/workspaces/{workspace_id}/contacts |
| Organisations | GET /v1/workspaces/{workspace_id}/organisations |