Run Saved Report

POST 
/api/v2/custom-reports/:id/run

Execute a saved custom report by ID. The report must belong to or be shared with the authenticated user.

Required scope: reports:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Optional body parameter:

• limit (integer, default 500): Maximum number of rows to return

Returns 404 if the report is not found. Returns 422 if the report definition is invalid (e.g., references unknown entities or columns).

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.