The Conferma API supports sorting and paging for endpoints that return a list of resources.
Query Parameters
Use the following query parameters to control the sorting and pagination of returned lists.
| Parameter | Description | Values |
|---|---|---|
page | The page number of the results, as a non-zero integer. Enables you to filter by page number. Use in combination with page_size. | Default: 1 Minimum Value: 1 Maximum Value: 50 |
pageSize | Limits the number of items returned. | Default: 15 Minimum Value: 1 Maximum Value: 100 |
sortBy | Allows the result set to be ordered. | Values vary by resource model. |
sortOrder | Allows the result set order direction to be changed. | Possible values:desc (descending order)asc (ascending order) |
Response Properties
List results are returned in a paged data response model. The following properties will be included in the response.
| Name | Type | Description |
|---|---|---|
totalItems | integer | Number of items returned in the response. |
totalPages | integer | Number of pages returned in the response. |
pageNumber | integer | Current selected page number. |
pageSize | integer | Number of items per page. |
items | array of objects | An array of resources. |
Sample Paged Data Response
{
"totalItems":1,
"totalPages":1,
"pageNumber":1,
"pageSize":15,
"items":[
...
]
}