Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Query Parameters

type
string
required

The webhook event, such as sales.order.confirmed.

Maximum string length: 100
limit
integer

How many events, newest first: 1 to 100, 3 when left out.

Required range: 1 <= x <= 100

Response

Array of DeliveryEnvelopeResource

data
DeliveryEnvelopeResource · object[]
required