Skip to main content
POST
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.

Body

application/json
name
string
required
Maximum string length: 255
abilities
enum<string>[]
required
Minimum array length: 1

What an API key may do: read or write one module, or everything. A key never does more than its owner's permissions allow.

Available options:
*,
access:read,
access:write,
audit:read,
address:read,
address:write,
billing:read,
billing:write,
catalog:read,
catalog:write,
dashboard:read,
dashboard:write,
developer:read,
developer:write,
devices:read,
devices:write,
documents:read,
documents:write,
notifications:read,
notifications:write,
inventory:read,
inventory:write,
purchasing:read,
purchasing:write,
quality:read,
quality:write,
sales:read,
sales:write,
engineering:read,
engineering:write,
manufacturing:read,
manufacturing:write,
automation:read,
automation:write,
insights:read,
insights:write,
integrations:read,
integrations:write,
labels:read,
labels:write,
library:read,
organization:read,
organization:write,
planning:read,
planning:write,
sync:read,
sync:write
expires_on
string<date> | null

Response

IssuedApiKeyResource

data
IssuedApiKeyResource · object
required