Skip to main content

Query DataTable Model

GET 
/api/data-tables

Execute a paginated DataTable 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​

Successful response