GET /contacts

Get all the contacts

Servers

Query parameters

Name Type Required Description
createdSince String No

Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

limit Integer No

Number of documents per page

Default value: 50

modifiedSince String No

Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

filter String No

Filter the contacts on the basis of attributes. Allowed operator: equals. For multiple-choice options, the filter will apply an AND condition between the options. For category attributes, the filter will work with both id and value. (e.g. filter=equals(FIRSTNAME,"Antoine"), filter=equals(B1, true), filter=equals(DOB, "1989-11-23"), filter=equals(GENDER, "1"), filter=equals(GENDER, "MALE"), filter=equals(COUNTRY,"USA, INDIA")

sort String No

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Valid values:

  • "desc"
  • "asc"

Default value: "desc"

listIds[] Array No

Ids of the list. Either listIds or segmentId can be passed.

segmentId Integer No

Id of the segment. Either listIds or segmentId can be passed.

offset Integer No

Index of the first document of the page

Default value: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.