Specification
| Attribute | Description | Type |
|---|---|---|
| attributes | List of attributes to be returned in the API response | Array of strings |
| includes | Additional relationships to be included in the response | Object with keys and arrays |
| filters | Filters to be applied to the resources returned by the API | Object containing filtering criteria |
| sort | Field by which the results should be sorted | String or null |
| count | Indicates whether the response should include the total count of resources | Boolean |
| limit | Maximum number of resources to be returned in a single call | Integer |
| page | Page number to be retrieved | Integer |
| search | Search term to search for resources based on a general search criterion | String or null |
Filter Operators
The Public API supports a variety of filter operators that can be applied to different data types. These operators make it easier to query and obtain more specific results when making requests involving filters. Below is a list of available operators, organized by data type:
String
eq(Equal): Equal to.neq(Not Equal): Not equal to.ilk(Il-like): Similar to a substring.ew(Ends With): Ends with.sw(Starts With): Starts with.
Number
eq(Equal): Equal to.neq(Not Equal): Not equal to.gt(Greater Than): Greater than.gte(Greater Than or Equal): Greater than or equal to.lt(Less Than): Less than.lte(Less Than or Equal): Less than or equal to.btw(Between): Within the range (inclusive).nbtw(Not Between): Outside the range.
Boolean
eq(Equal): Equal to.neq(Not Equal): Not equal to.
Date
eq(Equal): Equal to.neq(Not Equal): Not equal to.gt(Greater Than): Greater than.gte(Greater Than or Equal): Greater than or equal to.lt(Less Than): Less than.lte(Less Than or Equal): Less than or equal to.btw(Between): Within the range (inclusive).nbtw(Not Between): Outside the range.
Enumeration
in(In): Value is within the set.nin(Not In): Value is not within the set.
Use these operators when constructing your filters to refine queries and obtain more accurate results.