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.

Authentication

Tokens: OAuth 2.1 with PKCE, client credentials, revocation

OperationMethod and path
Revoke a tokenPOST /v1/auth/revoke
Get tokensPOST /v1/auth/token

Me

You, your companies and your devices

OperationMethod and path
Who you areGET /v1/me
Your devicesGET /v1/me/devices
Sign a device outDELETE /v1/me/devices/{device_id}
Your preferencesGET /v1/me/preferences
Change your preferencesPATCH /v1/me/preferences

Inbox

What waits for you, and what happened

OperationMethod and path
Your activityGET /v1/workspaces/{workspace_id}/activity
Mark activity readPOST /v1/workspaces/{workspace_id}/activity/read
Your inboxGET /v1/workspaces/{workspace_id}/inbox
How many are waitingGET /v1/workspaces/{workspace_id}/inbox/count

People

The people and groups of a workspace

OperationMethod and path
Departments and groupsGET /v1/workspaces/{workspace_id}/groups
PeopleGET /v1/workspaces/{workspace_id}/people
One personGET /v1/workspaces/{workspace_id}/people/{person_id}

Approvals

Documents and time off waiting for your decision

OperationMethod and path
Approvals waiting for youGET /v1/workspaces/{workspace_id}/approvals
One approvalGET /v1/workspaces/{workspace_id}/approvals/{approval_id}
ApprovePOST /v1/workspaces/{workspace_id}/approvals/{approval_id}/approve
DeclinePOST /v1/workspaces/{workspace_id}/approvals/{approval_id}/decline
Ask for changesPOST /v1/workspaces/{workspace_id}/approvals/{approval_id}/request-changes

Time off

Your leave, balances, the calendar and sickness

OperationMethod and path
Your balancesGET /v1/workspaces/{workspace_id}/timeoff/balances
Who’s awayGET /v1/workspaces/{workspace_id}/timeoff/calendar
Leave typesGET /v1/workspaces/{workspace_id}/timeoff/leave-types
Public holidaysGET /v1/workspaces/{workspace_id}/timeoff/public-holidays
Your time offGET /v1/workspaces/{workspace_id}/timeoff/requests
Book time offPOST /v1/workspaces/{workspace_id}/timeoff/requests
One requestGET /v1/workspaces/{workspace_id}/timeoff/requests/{request_id}
Cancel time offPOST /v1/workspaces/{workspace_id}/timeoff/requests/{request_id}/cancel
Preview time offPOST /v1/workspaces/{workspace_id}/timeoff/requests/preview
I’m backPOST /v1/workspaces/{workspace_id}/timeoff/sickness/end
I’m off sickPOST /v1/workspaces/{workspace_id}/timeoff/sickness/start

Webhooks

Events sent to your server, signed, with a delivery log

OperationMethod and path
EventsGET /v1/workspaces/{workspace_id}/events
WebhooksGET /v1/workspaces/{workspace_id}/webhooks
SubscribePOST /v1/workspaces/{workspace_id}/webhooks
UnsubscribeDELETE /v1/workspaces/{workspace_id}/webhooks/{webhook_id}
One webhookGET /v1/workspaces/{workspace_id}/webhooks/{webhook_id}
DeliveriesGET /v1/workspaces/{workspace_id}/webhooks/{webhook_id}/deliveries
Send againPOST /v1/workspaces/{workspace_id}/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver
Rotate the secretPOST /v1/workspaces/{workspace_id}/webhooks/{webhook_id}/rotate-secret

Documents

Envelopes, templates and document types

OperationMethod and path
Document rolesGET /v1/workspaces/{workspace_id}/document-roles
Document typesGET /v1/workspaces/{workspace_id}/document-types
EnvelopesGET /v1/workspaces/{workspace_id}/envelopes
Start an envelopePOST /v1/workspaces/{workspace_id}/envelopes
One envelopeGET /v1/workspaces/{workspace_id}/envelopes/{envelope_id}
Change a draftPATCH /v1/workspaces/{workspace_id}/envelopes/{envelope_id}
The audit trailGET /v1/workspaces/{workspace_id}/envelopes/{envelope_id}/audit
RemindPOST /v1/workspaces/{workspace_id}/envelopes/{envelope_id}/remind
Save as a templatePOST /v1/workspaces/{workspace_id}/envelopes/{envelope_id}/save-as-template
SendPOST /v1/workspaces/{workspace_id}/envelopes/{envelope_id}/submit
VoidPOST /v1/workspaces/{workspace_id}/envelopes/{envelope_id}/void
FieldsGET /v1/workspaces/{workspace_id}/fields
TemplatesGET /v1/workspaces/{workspace_id}/templates
One templateGET /v1/workspaces/{workspace_id}/templates/{template_id}

Contacts

The people and companies you send to

OperationMethod and path
ContactsGET /v1/workspaces/{workspace_id}/contacts
Add a contactPOST /v1/workspaces/{workspace_id}/contacts
OrganisationsGET /v1/workspaces/{workspace_id}/organisations

On this page