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

A report definition to run and the page of it to return. Its shape is checked here, by these rules and then by report-definition.schema.json; whether its fields exist and are the person's to use is checked when it runs.

definition
object
required
page
integer

The page of a grouped report, from 1.

Required range: 1 <= x <= 10000
cursor
string | null

For a report that lists rows, the next_cursor of the page before.

Maximum string length: 4000
page_size
integer

Rows a page holds: 1 to 1000, 100 by default.

Required range: 1 <= x <= 1000

Response

ReportResultResource

data
ReportResultResource · object
required