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

string

length ≤ 40

Start of the sent-date range (inclusive). Two formats: (1) Calendar day YYYY-MM-DD (e.g. 2024-07-02) — start of that day in UTC (00:00:00.000Z). (2) ISO-8601 UTC timestamp (e.g. 2024-07-02T07:00:00.000Z) — exact UTC bound. Optional independently of sentEnd.

sentEnd

string

length ≤ 40

End of the sent-date range (inclusive). Two formats: (1) Calendar day YYYY-MM-DD (e.g. 2024-07-02) — end of that day in UTC (23:59:59.999Z). (2) ISO-8601 UTC timestamp (e.g. 2024-07-03T06:59:59.999Z) — exact UTC bound. Optional independently of sentStart.

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

Sort direction. Accepted values: asc, desc. Defaults to desc when omitted.

Allowed:

limit

integer

1 to 1000

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

Language

Credentials

Header

Loading…

Response

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

application/json

application/problem+json

200Paginated email list

400Bad request — request validation failed (invalid query/path parameters; type …/validation-error with optional errors[]), and/or organization has no accounting integration configured.

401Unauthorized

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

404Organization not found

429Too Many Requests