List all partners for authenticated distributor

get

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

Access: Requires DISTRIBUTOR actor type

Lists all Partners (MSP, accountant, ISO) under the authenticated distributor with pagination and optional filtering.

Features:

Sorted alphabetically by name
Filter by status or externalId
Includes organization count for each partner

Requires JWT authentication and 'partners:accounts:read' scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

status

string

enum

Optional filter by partner status

Allowed:

externalId

string

length ≤ 100

Optional filter by external ID (exact match)

limit

integer

1 to 100

Number of results per page (default: 20, max: 100)

offset

integer

0 to 9007199254740991

Number of results to skip for pagination (default: 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

Bearer

JWT

Loading…

Response

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

application/json

application/problem+json

200Successful response with paginated list of partners

401Unauthorized - Invalid or missing authentication token

403Forbidden - Wrong actor type or missing scope

429Too Many Requests - Rate limit exceeded