Email campaigns (legacy)

List email campaign contacts (paginated)

Returns a page of the campaign recipients. Pagination is 0-based (page=0 is the first page). perPage defaults to 20, values below 10 are forced to 20, and values above 10000 are capped at 10000. The response envelope is { success, list, count } (NOT { contacts, total }). event filters by contact status and MUST be an array (e.g. event[]=REPLIED); a bare string is rejected (contrast with the LinkedIn variant which also accepts a string). New integrations should use the multichannel /advanced campaign endpoints instead.

get/emails/campaign/contacts

Request

  • Base URL: https://api.emelia.io
  • URL: https://api.emelia.io/emails/campaign/contacts
  • Auth: API key in header Authorization

Query parameters

idstring required

Campaign ObjectId.

pagestring required

0-based page index (sent as a string).

perPagestring

Page size. Default 20, min 10 (else forced to 20), max 10000.

eventstring[]

Filter by contact status. Must be an array.

querystring

Full email match, or space-separated tokens matched against email/firstName/lastName.

Response

One page of contacts.

successtrue required
countinteger required

Total number of matching contacts.

Changes

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