Common Filters

Overview

Most endpoints that return multiple items can be filtered with the following common query parameters.

Available Filters

ids

Add the id or ids argument to a collection if you want to request multiple records of which you know their IDs. For example, if you want to retrieve the names of users 14 and 23 in a single request, you can request:

GET /v1/users?ids=14,23&fields=id,name

idLessThan, idGreaterThan

Add the idLessThan or idGreaterThan query parameters if you wish to limit the records to a certain range. You can specify either of them alone, or both at the same time. For example to get all contacts with IDs between 1000 and 2000:

GET /v1/people?fields=id,name&idGreaterThan=1000&idLessThan=2000

createdAfter, createdBefore

Use the createdAfter and createdBefore parameters if you wish to limit the records returned to those created in a certain date range. You can specify either of them alone, or both at the same time. These parameters expect an ISO-8601 date in the UTC timezone. For example to get all contacts created after July 1st, 2021:

GET /v1/people?fields=id,name,created&createdAfter=2021-07-01T04:00:00Z

updatedAfter, updatedBefore

Use the updatedAfter and updatedBefore parameters to limit the records return to those updated in a certain date range. You can specify either of them alone, or both of them at the same time. These parameters expect an ISO-8601 date in the UTC timezone.

GET /v1/people?fields=id,name,updated&updatedAfter=2021-07-01T04:00:00Z

πŸ“˜

Updated Field Accuracy

The updated fields may not be accurate for all records, as the field is only updated when the record itself changes, but related information may be stored in separate records. For example, if a note is added to a contact, that note is a distinct record, so the contact's updated field will not change.