Get person email log

get

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

Retrieve the emails sent to the given person, with delivery status and open tracking. Private, giving-related campaign emails are hidden unless you have the Full Read Contributions permission.

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 person.

Query Params

status

string

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

subject

string

Return emails whose subject contains the given text.

opened.start

date-time

Return emails first opened on or after this date.

opened.end

date-time

Return emails first opened on or before this date.

count.start

double

Return emails opened at least this many times.

count.end

double

Return emails opened at most this many times.

sentOn.start

date-time

Return emails sent on or after this date.

sentOn.end

date-time

Return emails sent on or before this date.

sentBy

string

Return emails sent by the given user name.

fromName

string

Return emails whose reply-to display name contains the given text.

fromEmail

string

Return emails whose reply-to email address contains the given text.

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.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK