Query Parameters - Advocate API

Pagination

Most top-level API resources within Advocate provide support for bulk fetches using ‘list’ API methods. For details on which resources support the list functionality, please refer to the specific endpoints in the API Reference. These ‘list’ API methods follow a common structure, using any of the following parameters:

offset: Allows you to specify the page of results you want to retrieve.
limit: Enables you to determine the number of items to display per page in the results. Default is 15 and maximum is 100.

Example:

GET /rest/cases?limit=1&offset=20

Filters

Queries can accept filter parameter utilizing the following syntax:

GET /rest/cases?field[operator]=value

Supported fields on all resources:

Field	Description
`createdAt`	Date resource was created
`updatedAt`	Date resource was last updated

Supported operations include:

Operator	Description
`gt`	Greater than
`gte`	Greater than or equal
`lt`	Less than
`lte`	Less than or equal
`in`	Exists inside an array
`eq`	Equal to a value

Please note that only a subset of operators is supported and depends on the value type. Please refer to the list of supported operator by field type below.

Date and Date-Time Values

Operator	Description
`gt`	Greater than
`gte`	Greater than or equal
`lt`	Less than
`lte`	Less than or equal

String Values

Operator	Description
`in`	Exists inside an array
`eq`	Equal to a value

Boolean Values

Operator	Description
`eq`	Equal to a value

Enum Values

Operator	Description
`eq`	Equal to a value

​Pagination

​Filters

​Date and Date-Time Values

​String Values

​Boolean Values