Qodex.ai

List Contacts In Mailing List

GET {{baseUrl}}/directories/:directoryId/mailinglists/:mailingListId/contacts?pageSize=50&skipToken=irure reprehenderit dolore enim veniam&includeEmbedded=false

Return a list of contacts in a specified mailing list. <!--From Readme--> For the last page of results, the value associated with nextPage will be null. <!-- theme: warning -->

This API call is only available to XM Directory users.

The maximum value for pageSize is 50.

The new string-based pagination functionality results in improved performance and a lower rate of timeouts. To opt in, append query parameter useNewPaginationScheme=true.

Request Params

KeyDatatypeRequiredDescription
pageSizenumberThe maximum number of items to return per request
skipTokenstringThe start position for pagination
includeEmbeddedbooleanWhether embeddedData is returned in the response.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;result&quot;:{&quot;elements&quot;:[{&quot;contactId&quot;:&quot;CID_012345678901234&quot;,&quot;firstName&quot;:&quot;veniam dolore in laboris qui&quot;,&quot;lastName&quot;:&quot;dolore quis ullamco&quot;,&quot;email&quot;:&quot;non incididunt ut in sunt&quot;,&quot;phone&quot;:&quot;fugiat esse&quot;,&quot;extRef&quot;:&quot;anim in&quot;,&quot;language&quot;:&quot;Lorem sit Ut&quot;,&quot;unsubscribed&quot;:true,&quot;embeddedData&quot;:{&quot;eu3&quot;:&quot;eu tempor sit et&quot;,&quot;dolore_c5&quot;:&quot;sed Ut cupidatat proident culpa&quot;}},{&quot;contactId&quot;:&quot;CID_012345678901234&quot;,&quot;firstName&quot;:&quot;reprehenderit se&quot;,&quot;lastName&quot;:&quot;et ea Lorem&quot;,&quot;email&quot;:&quot;incididunt sunt u&quot;,&quot;phone&quot;:&quot;Ut deserunt elit&quot;,&quot;extRef&quot;:&quot;in nulla aliquip incididunt&quot;,&quot;language&quot;:&quot;Excepteur pariatur laboris&quot;,&quot;unsubscribed&quot;:true,&quot;embeddedData&quot;:{&quot;ipsum_0&quot;:97779719}}],&quot;nextPage&quot;:&quot;dolore commodo&quot;},&quot;meta&quot;:{&quot;httpStatus&quot;:&quot;ut Duis id&quot;,&quot;requestId&quot;:&quot;quis Lorem&quot;,&quot;notice&quot;:&quot;dolor tempor consectetur&quot;}}