When using GET methods, the page and pageSize query parameters are required to set which page is returned and the maximum number of results per page.
Example:
GET /customers?page=1&pageSize=10This returns the first 10 records. The maximum pageSize supported is 1000 for performance reasons.
Use pagination efficiently - don't request more data than you need. Contact support if you would like help in performing batch operations.
Most search APIs support the sort query parameter to set the returned sort order - this allows a common-delimited list of fields and will default to ascending order. Use the :desc suffix to change to descending order.
GET list methods support searching by key fields which will vary depending on the API. Where they are string fields, they will support in: and like: prefixes to perform SQL IN or LIKE queries. Date fields support lt: and gt: prefixes for less than and greater than queries
GET list methods may also support filtering so only certain fields are returned in the response - this is via the fields query parameter which takes a commo-delimited list.