Search email recipients

get

https://{tenant}.onechurchsoftware.com/api/emails/campaigns/{id}/recipients

Retrieve the recipients of a sent email, with each recipient's delivery status and opens.

Required permission: Full Read Email Logs

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the campaign.

Query Params

name

string

Text matched against the recipient's names and aliases. When multiple words are given, every word must match.

string

Return recipients whose email address contains the given text.

status

string

Comma-delimited list of delivery status ids: 1 = Sent, 2 = Delivered, 3 = Bounced, 4 = Complaint, 5 = Failed.

opens.start

double

Return recipients who opened the email at least this many times.

opens.end

double

Return recipients who opened the email at most this many times.

opened.start

date-time

Return recipients who opened the email on or after this date.

opened.end

date-time

Return recipients who opened the email on or before this date.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

200OK