Qodex.ai

Get contacts in a list

GET {{baseUrl}}/contacts/lists/:listId/contacts?modifiedSince=veniam elit in&limit=50&offset=0&sort=desc

Request Params

KeyDatatypeRequiredDescription
modifiedSincestringFilter (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.
limitnumberNumber of documents per page
offsetnumberIndex of the first document of the page
sortstringSort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"contacts":[{"email":"alex.pain@example.com","id":45,"emailBlacklisted":false,"smsBlacklisted":true,"createdAt":"2017-05-12T12:30:00.000Z","modifiedAt":"2017-05-12T12:30:00.000Z","listIds":[12,9,20],"listUnsubscribed":[1,2],"attributes":{"LASTNAME":"Pain","FIRSTNAME":"Alex","DOB":"2010-12-31T00:00:00.000Z","GENDER":"Kid"}},{"email":"john.smith@example.com","id":32,"emailBlacklisted":true,"smsBlacklisted":false,"createdAt":"2017-05-12T12:30:00.000Z","modifiedAt":"2017-05-12T12:30:00.000Z","listIds":[12],"listUnsubscribed":[1],"attributes":{"LASTNAME":"Smith","FIRSTNAME":"John","DOB":"1986-06-21T00:00:00.000Z","GENDER":"Men"}},{"email":"helen.rose@example.com","id":65,"emailBlacklisted":true,"smsBlacklisted":false,"createdAt":"2017-05-12T12:30:00.000Z","modifiedAt":"2017-05-12T12:30:00.000Z","listIds":[12,9,20],"listUnsubscribed":[1],"attributes":{"LASTNAME":"Rose","FIRSTNAME":"Helen","DOB":"1988-11-02T00:00:00.000Z","GENDER":"Women","SMS":"3375599887766"}}],"count":17655}