List Organizations

get

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

Access: Requires DISTRIBUTOR or PARTNER actor type.

Lists Organizations with optional filtering and pagination.

Distributor: Returns all organizations under the distributor. Use partnerId to filter by a specific partner, or directOnly=true to return only distributor-direct organizations.
Partner: Returns only the partner's own organizations. The partnerId and directOnly query params are ignored.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

partnerId

string

^[0-9a-fA-F]{24}$

Filter by partner MongoDB ObjectId. Distributor callers only — returns organizations under the specified partner. Ignored for partner callers (already scoped to their own partner).

directOnly

string

enum

When true, only return distributor-direct organizations (apiParent.type = distributor). Cannot be combined with partnerId.

Allowed:

status

string

enum

Filter by organization status

Allowed:

closed

string

enum

Filter by closed flag (true = only closed, false = only active)

Allowed:

externalId

string

length between 1 and 100

^[a-zA-Z0-9_-]+$

Filter by organization's external ID

limit

integer

1 to 100

Maximum number of results to return (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

200Successful response with paginated list of organizations

401Unauthorized - Invalid or missing authentication token

403Forbidden - Invalid actor type or partner accessing another partner's organizations

404Not Found - Partner not found or does not belong to distributor

429Too Many Requests - Rate limit exceeded