Get Custom Report

GET 
/api/v2/custom-reports/:id

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

Required scope: reports:read

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

Returns the full custom report object including the user name (eager-loaded). Returns 404 if the report is not found or not accessible.

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.

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.