List Email Broadcasts

GET /tenants/{tenant}/email-broadcasts

Returns a paged list of email broadcasts for the tenant, newest first. Filter by status.

Requires: ViewAll on EmailBroadcasts.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by. Valid values depend on the resource.

CreatedDate Status

Field to sort by. Valid values depend on the resource.

CreatedDate Status

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

status query string

Filter by broadcast status (Draft, Queued, Sending, Completed, Failed, Cancelled)

Filter by broadcast status (Draft, Queued, Sending, Completed, Failed, Cancelled)

Responses

401 Unauthorized – Invalid or missing API key
403 Forbidden – the caller lacks the permissions this endpoint requires; the detail lists every one missing
application/problem+json