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

automation
string<uuid> | null

Only this automation's runs.

status
enum<string> | null

Where a run is. A run is queued, then running; it waits only for an answer to an approval, and ends succeeded, failed or cancelled, or rejected or timed out at an approval. A run refused because the month's runs are used up is kept as not started and counts toward nothing.

Available options:
queued,
running,
waiting,
succeeded,
failed,
cancelled,
not_started,
rejected,
timed_out
from
string<date> | null

YYYY-MM-DD: runs started on or after this day.

to
string<date> | null

YYYY-MM-DD: runs started on or before this day.

after
string<uuid> | null

The next_cursor of the page before.

Response

RunPageResource

data
RunPageResource · object
required