Get Distinct Field Values (Autocomplete)

GET 
/api/v2/report-builder/field-values/sales_orders/order_status

Return distinct values for a given entity/field. Used to populate autocomplete dropdowns in the filter builder UI (e.g., distinct order_status values).

Respects tenant isolation. Supports an optional search query param for LIKE matching and a limit param to cap results.

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.

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.