/
5 minute read
January 19, 2022

Sorting and Pagination

The Core API supports sorting and pagination for endpoints that return arrays of resources. The sorting mechanism places the resources in order; the pagination mechanism then returns a specific range of those ordered resources. You control sorting and pagination through URL query parameters.

A GET request to the /users endpoint returns an array of users. By default, the sorting mechanism places the most recently modified users at the top of the sort order (sort_by=-lastModifiedTime) and the pagination mechanism then returns the first five users (count=5&start_index=0). The following URL shows this default setting in an explicit form:

Bash
Copied

Is this helpful?

Yes
No

The next five users in the sort order could then be returned with this URL (start_index is now set to 5):

Bash
Copied

Is this helpful?

Yes
No

Query parameter details

The following table provides details on the URL query parameters that control the sorting and pagination of returned arrays.

Query Parameter Description Values

sort_by

Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.

NOTE: You must sort using system field names such as lastModifiedTime and createdTime, and not by the field names appearing in response bodies such as last_modified_time or created_time.

Allowable Values:
lastModifiedTime, createdTime, or any field in the resource model

Default Value:
‑lastModifiedTime

count

Specifies the number of resources to return.

Allowable Values:
1–100

Default Value:
5

start_index

Specifies the sort order index from which to begin returning data.

Allowable Values:
Any integer

Default Value:
0 (the first row)

Response field details

Name Type Description

count

integer

The number of resources returned.

Allowable Values:
1–100

start_index

integer

The sort order index of the first resource in the returned array.

Allowable Values:
Any integer

end_index

integer

The sort order index of the last resource in the returned array.

Allowable Values:
Any integer

is_more

boolean

A value of true indicates that more unreturned resources exist.

Allowable Values:
true, false

data

array of objects

Contains the returned resources.

Sample response body

JSON
Copied

Is this helpful?

Yes
No

Subscribe to our developer newsletter