List sent emails for an Organization

get

https://api.benjipays.com/v2/emails

Returns paginated sent emails for the organization associated with the authenticated API key. Matches the merchant-app email history, restricted to merchant-facing email types. Filter by customer, type, status, and sent-date range.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customerId

string

length ≤ 200

Filter to a single accounting customer ID.

type

string

enum

Filter by merchant-facing email type. Internal types cannot be queried.

status

string

enum

Filter by delivery status (sent, queued, error).

Allowed:

sentStart

date-time

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Start of the sent-date range as an ISO-8601 UTC timestamp (inclusive), e.g. 2024-01-01T00:00:00.000Z.

sentEnd

date-time

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

End of the sent-date range as an ISO-8601 UTC timestamp (inclusive), e.g. 2024-01-31T23:59:59.999Z.

string

length ≤ 200

Free-text search across email fields (recipient, subject, etc.).

sort

string

enum

Sort field (sentDate, subject, status, type).

Allowed:

order

string

enum

Allowed:

limit

integer

1 to 100

Defaults to 20

offset

integer

0 to 9007199254740991

Defaults to 0

Headers

X-Request-ID

uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

X-Correlation-ID

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Paginated email list

401Unauthorized

403Forbidden — missing required OAuth scope (organizations:emails:read) and/or insufficient live mapping permission on the API key owner (e.g. companyAdmin). Scope and mapping are independent gates; see response detail.

404Organization not found

429Too Many Requests