| Field | Type | Required | Description | Example |
|---|---|---|---|---|
after |
OffsetDateTime | ➖ | Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store. | 2017-01-02T02:00:00Z |
before |
OffsetDateTime | ➖ | Used to query records that have been added or updated before this time point. | 2017-01-02T02:00:00Z |
limit |
Optional<Long> | ➖ | The maximum number of records to return per page. | 100 |
token |
Optional<String> | ➖ | The continuation token returned from a previous class. This must be a valid UUID v4 if provided. This will override any other pageable parameters provided. |
0e28af57-511f-47ab-ae46-46cd1ca51a1a |
filter |
Optional<String> | ➖ | Use filter query parameters to limit results to data that matches your criteria. See Filters for details. Supported fields and operators are listed below: | Field | Operators | Notes | |------------------|-------------------------------------|-------| | id | eq, ne | || sourceId | eq, ne | || firstName | eq, ne, contains, sw | || lastName | eq, ne, contains, sw | || email | eq, ne, contains, sw | || ccEmail | eq, ne | || company | eq, ne | || type.id | eq, ne | || nickname | eq, ne | || title | eq, ne | || workPhone | eq, ne | || middleName | eq, ne | || mobilePhone | eq, ne | || homeFax | eq, ne | || designation | eq, ne | || homePhone | eq, ne | || pager | eq, ne | || workFax | eq, ne | || lastModifiedBy | eq, ne | || lastModified | eq, ne, lt, le, gt, ge | || created | eq, ne, lt, le, gt, ge | || createdBy | eq, ne | || workAddress.address1 | eq, ne | || workAddress.address2 | eq, ne | || workAddress.address3 | eq, ne | || workAddress.city | eq, ne | || workAddress.country | eq, ne | || homeAddress.address1 | eq, ne | || homeAddress.address2 | eq, ne | || homeAddress.address3 | eq, ne | || homeAddress.city | eq, ne | || homeAddress.country | eq, ne | || deleted | eq, ne | Filters for deleted contacts. To retrieve purged contacts, see the includePurged parameter. || customField.{uuid of custom field} | eq, ne, lt, le, gt, ge, sw, contains | || optOut.optedOut | eq, ne | |The following logical operators are supported for combining filters: * and * or |
firstName eq 'John' or lastName eq 'Anderson' |
includePurged |
Optional<Boolean> | ➖ | True means purged contacts can be included in the response. Purged contacts contain only limited display data (id, lastModified, and purged). When true, the filter query parameter can only filter by the id field. The before, after, limit, and token query parameters are still valid query parameters to use with this parameter. If false, only contacts that have not been purged will be returned. |