Query list view Model
GET/api/data-tables
Execute a paginated list view query against a model. The model must implement DataTableBlueprintInterface. Supports search, filtering (via filter[] params or a saved_view_id), and pagination.
Authentication: Requires Bearer token.
Query Parameters:
- model (required, string): Fully qualified model class name
- search (optional, string): Full-text search query
- filter (optional, array): Filter conditions — mutually exclusive with saved_view_id
- saved_view_id (optional, integer): Load state from a saved view — mutually exclusive with filter[]
- include_data_table_blueprint (optional, boolean): Include the blueprint config in response
- include_saved_views (optional, boolean): Include all saved views for the model
Errors:
- 400 ScopeFilterDoesNotExistException: Invalid filter scope
- 400 BadScopeFilterValueException: Invalid filter value
Request
Responses
- 200
- 400
- 401
- 403
- 429
OK
Response Headers
Bad Request
Response Headers
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.
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.