Export Custom Report
POST/api/v2/custom-reports/:id/export
Export a saved custom report. The response is a streamed/binary download in the requested format.
reports:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Request body:
format(string, required): One ofcsv,xlsx,pdf
Returns 200 with a file download. Returns 404 if the report is not owned by or shared with the caller.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
Successful response
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.
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.