Search email campaigns

get

https://{tenant}.onechurchsoftware.com/api/history/email/campaigns

Retrieve sent emails with their delivery and open statistics. Without permission to view email logs, only campaigns the signed-in user sent or replies to are returned. Private, giving-related campaigns 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…

Query Params

entry

int32

≥ 1

The id of a campaign. Returns only that campaign.

from

string

Return campaigns whose reply email address contains the given text.

recipient

string

Return campaigns sent to a recipient whose name or email address contains the given text. When multiple words are given, every word must match.

message

string

Return campaigns whose message body contains the given text.

subject

string

Return campaigns whose subject contains the given text.

automated

boolean

When true, return only automated (system-sent) campaigns; when false, only manually composed ones.

timestamp.start

date-time

Return campaigns sent on or after this date.

timestamp.end

date-time

Return campaigns sent on or before this date.

openRate.start

double

Return campaigns with an open rate of at least this percentage.

openRate.end

double

Return campaigns with an open rate of at most this percentage.

attachment

boolean

Whether the campaign included an attachment.

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