Campaigns

List campaign recipients

Returns a campaign run's recipients in the order the run admitted them, optionally filtered by status. Pass nextCursor back as cursor for the next page; it is null on the last page.

get/v1/campaigns/{id}/runs/{runId}/recipients

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/campaigns/{id}/runs/{runId}/recipients
  • Auth: API key in header x-api-key

Path parameters

idstring required
runIdstring required

Query parameters

status'pending' | 'dispatching' | 'dispatched' | 'failed' | 'skipped' nullable
limitstring nullable
cursorstring

Response

CampaignRecipientPage

nextCursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.