Pagination and Filtering

Responses are paginated with a default page size of 20. If more results are available, the response will include "hasMore": true.

To retrieve the next page, use the "lastId" parameter:

curl -H "key: [apiKey]" -H "tenant: [tenant]" "https://dev.v3manager.com/api/model/customer?lastId=23"

To adjust the number of results per page, use the "limit" parameter (allowed range: 20 - 100).

By default the responses don't include null fields. If you want to include them add includeNulls=true

https://dev.v3manager.com/api/model/customer?includeNulls=true

Field Selection

You can specify which fields to include in the response. Some fields, like "id", are always included.

https://dev.v3manager.com/api/model/customer?fields=["name", "avatar"]

URL parameters are shown unencoded for clarity but must be encoded:

https://dev.v3manager.com/api/model/customer?fields=%5B%22name%22%2C%20%22avatar%22%5D

Filtering

To filter results, use the format ["field", "operator", "value"]. Examples:

Filter by date

https://dev.v3manager.com/api/model/customer?search=[“created”,“>”,“05-07-2023”]

Filter by null values

[“end”,“=”,null]

Include deleted records

[“deleted”,“in”,[0,1]]

Nested filters

You can nest filters by including “OR” or “AND” as the first element of the list of filters [“OR”, [“status”,“in”,[3,4]], [“price”,“=”,0]]

Filter records created or updated since a date

[“OR”, [“created”,“>”,“2023-07-01”], [“updated”,“>”,“2023-07-01”]]

Sorting

To sort results, use the “sort” parameter with the format: “column” or “column asc|desc”.

https://dev.v3manager.com/api/model/customer?sort=name

Sort in ascending order (explicit)

https://dev.v3manager.com/api/model/customer?sort=name asc

Sort in descending order

https://dev.v3manager.com/api/model/customer?sort=created desc

Note: Only one sort field is supported per request. The default sort direction is ascending (ASC) if not specified.