🔄 Sorting
The sort parameter allows you to specify the sorting criteria when retrieving contacts from the API. It is structured as an object with two attributes: property and direction.
- property: Specifies the field by which you want to sort the results (e.g., "name");
- direction: Defines the sorting direction ("asc" for ascending or "desc" for descending).
Example of sorting contacts by name in ascending order:
curl --location 'http://apiurl.com/contacts/?sort[property]=name&sort[direction]=asc' \
--header 'x-api-key: {your-api-key}'\
--header 'octa-agent-email: {agent-email}' \
You can use the sorting (sort), pagination (page and limit), and filtering (filters) features together to tailor your API queries and retrieve precisely the data you need