Common Query Parameters - Circuit Auction API

Pagination

Parameter	Type	Default	Description
`range`	integer	25	Items per page
`page`	integer	0	Page number (0-indexed)

Example

?range=25&page=2

Sorting

Use the sort parameter to order results by one or more fields.

Syntax

Ascending: ?sort=field_name
Descending: ?sort=-field_name
Multiple fields: ?sort=-created,id

Examples

# Sort by ID ascending
?sort=id

# Sort by created date descending
?sort=-created

# Multiple sort fields
?sort=-created,id

Filtering

Simple Filter

Filter by exact value match:

?filter[field_name]=value

IN Operator (Multiple Values)

Filter by multiple possible values:

?filter[field_name][value][0]=value1&filter[field_name][value][1]=value2&filter[field_name][operator]=IN

Range Filter

Filter by numeric or date range:

# Numeric range
?filter[field_name][value][from]=100&filter[field_name][value][to]=1000

# Date range
?filter[created][value][from]=2025-01-01&filter[created][value][to]=2025-12-31

Regex Search

Filter using regular expressions:

?filter[field_name][value]=search.*term&filter[field_name][operator]=REGEXP

Field Selection

Request only specific fields to reduce payload size:

?fields=id,label,status,created

Example

GET /api/v1.0/datatable-clients?fields=id,first_name,last_name,email

Global Search

Search across multiple fields at once:

?global_search=search+term

Example

GET /api/v1.0/datatable-clients?global_search=john