List customers for an Organization

get

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

Returns paginated Benji-controlled camelCase customer summaries for the organization associated with the authenticated API key. Mirrors the data set shown in the merchant-app customers table. List responses never include the stored customer object — use GET /customers/:customerId?include=accounting for that.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

length ≤ 200

Free-text search across customer fields (name, email, etc.).

includeDeleted

string

enum

Include customers that have been soft-deleted in the accounting system. Defaults to false to match the merchant-app customers table.

Allowed:

sort

string

length ≤ 50

Field to sort by (uses the same field names returned in the response). Accepted values: name (default).

order

string

enum

Sort direction. Accepted values: asc (default), desc.

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 customer list

401Unauthorized

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

429Too Many Requests