List Requests
List requests are used to retrieve multiple records with a single request. This is useful if requesting a list of meetings to build your own custom calendar tool, for example.
Choosing A Subset of Records
List requests will often contain very large datasets. By default, most list requests are limited to 50 results. listControl offers the ability to page through results or increase and decrease the number of results each request will provide.listControl contains the following elements:
| Element | Description |
|---|---|
startFrom |
When paging through results, this is set to the index of the first record you wish to retrieve. This is increased by your maximumNum for each subsequent request |
maximumNum |
Default 50. This sets the maximum number of results to return with a single request (max 500) |
listMethod |
AND or OR. When specifying multuple filtering options, determines whether you wish to consider all filters, or any filters. (default AND) |
Response to list requests will contain a matchingRecords elememt that will help determine if you have received all available results, or if you need to page through additional results.matchingRecords contains the following elements:
| Element | Description |
|---|---|
total |
The total number of available results |
returned |
The number of results included in the current response. This should match your maximumNum until you reach the end of the results list |
startFrom |
The starting index for the current results set. This should match the startFrom value from your request |