Skip to main content
GET
Lists users from the target organization and all its descendants.

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Headers

X-Organization-ID
string<uuid>

ID of the organization to scope this operation to. When omitted, users from the target org and all its descendants are returned. Must be a valid non-empty UUID. Present but empty or malformed values return 400.

Query Parameters

OrganizationType
enum<string>

Filter by organization type (VERTICAL_SOFTWARE_PROVIDER, EMBEDDED).

Available options:
BANK,
EMBEDDED,
PLATFORM,
TRANSACTOR,
VERTICAL_SOFTWARE_PROVIDER
Limit

Maximum number of results to return (default: 20, max: 100).

PaginationToken
string

Opaque pagination token from a previous response for cursor-based navigation.

ReportingManagerUserId
string<uuid>

Filter by reporting manager user ID. Returns only users whose reporting_manager_user_id equals this value.

Status
enum<string>

Filter by user status (default: ACTIVE). Filter for user status when querying users.

Available options:
ACTIVE,
INACTIVE,
INVITED,
ALL

Response

Returns the list of users from related organizations.

Response DTO for listing users from related organizations.

data
object[]
required
nextPaginationToken
null | string

A token to pass as pagination_token to get the next page of results. Null if there are no more pages after this one.

prevPaginationToken
null | string

A token to pass as pagination_token to get the previous page of results. Null if this is the first page.