Get SQL Schema

GET 
/api/v2/report-builder/sql/schema

List every table a SQL report may read, with its columns and types. Tables that back a report-builder entity include that entity's key and label. Only allowlisted tables are listed.

Required scope: reports:read

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

Requires the reports.sql permission (administrators always have it). Personal access tokens need the reports:write scope (reports:read is enough for Get SQL Schema). Users without the permission receive 403.

Request

Responses

200

OK

Response Headers

Content-Type

401

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

403

Forbidden

Response Headers

Content-Type

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.