Filter

Available filter fields

Field: filter

  • filter is option field.

  • Each key in the filter field is condition. Type of filter depends on type of field. See examples below.

  • You can find field name and type of filter in object description (Fields summary table).

Field: pagination

  • pagination is option field.

  • Default value of limit (page size) is 10.

  • Maximum value for page size is 100 for all objects.

Field: order

  • order is option field.

  • Default value: order[id] = "desc".

  • You can use multiple orders at the same time. Sorting is available only for specific fields. See fields summary table of object.

get
Filter

https://api.CLIENT_ID.item8.io/v1/entities
Full filter example for almost objects.
Request
Response
Headers
Item8-Api-Key
required
string
Authentication API key.
Query Parameters
filter[id_field]
optional
integer
Example condition of filter by id: id_field == 42
filter[string_field]
optional
string
Example condition of fulltext search: string_field LIKE "%qwerty%"
filter[num_field][from]
optional
integer
Example condition of filter by numeric range: num_field >= 42
filter[num_field][to]
optional
integer
Example condition of filter by numeric range: num_field <= 42
filter[date_field][from]
optional
string
Example condition of filter by date range: date_field >= "2017-12-30"
filter[date_field][to]
optional
string
Example condition of filter by date range: date_field <= "2017-12-30"
filter[enum_field]
optional
array
Example condition of filter by one of enum option: enum_field IN ("Active", "Draft")
pagination[limit]
optional
integer
Allow you to control the amount of data returned in that call. Defaults to 50 if omitted.
pagination[page]
optional
integer
The page of the result set returned. Defaults to 1 if omitted.
order[field]
optional
string
Direction of either asc or desc to order the results in ascending order or descending order by field, respectively.
200: OK
{
"status": "success",
"message": "",
"data": [
{
"id": 42,
"name": "Some item8 object name"
},
{
"id": 43,
"name": "Some another item8 object name"
}
]
}