Skip to content

List recipients

Request

Manage canonical campaign recipients without generation, personalization or sending. external_id maps to the existing campaign employee identity. Mutations require the campaign revision. Claimed, rendered, sent or otherwise active recipients cannot be edited or deleted. Contact details appear only in authorized recipient reads; mutation results contain indexed status metadata.

Security
bearerAuth
Path
idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
Query
limitinteger, [ 1 .. 100 ]
Default:50
cursorstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/engage/openapi/v1/campaigns/{id}/recipients?limit=50&cursor=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Current resource or page.

Headers
X-Request-Idstring, (uuid)required

Identifier for tracing this response.

ETagstring

Quoted opaque revision when the resource or job result has one.

Bodyapplication/json
dataArray of objects, <= 100 itemsrequired
nextCursorstring or nullrequired
Any of:
string
totalinteger, [ -9007199254740991 .. 9007199254740991 ]required
lockedTotalinteger, [ -9007199254740991 .. 9007199254740991 ]required
revisionstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
Response
{ "data": [ { … } ], "nextCursor": "string", "total": -9007199254740991, "lockedTotal": -9007199254740991, "revision": "string" }