v1

latestOpenAPI 3.0.12026-07-242682197.7 KB
Bulk Send

List Bulk Sendings

Returns information about the Bulk Send.

get/api/v1/bulk_sends

Query parameters

user_emailstring email

The email address of the user that sent the Bulk Send. Must have the admin or manager role to view Bulk Sends of other users. Defaults to the user that the API key belongs to.

limitinteger

The number of documents to fetch. Defaults to 10, max is 50.

pageinteger

The page number for pagination. Defaults to the first page.

api_application_idstring uuid

Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings

Response

successful

current_pageinteger required
next_pageinteger nullable
previous_pageinteger nullable
total_countinteger required
total_pagesinteger required