Skip to main content
GET
Lists organizations that have a relationship with the caller's organization.

Authorizations

Authorization
string
header
required

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

Query Parameters

Limit

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

PaginationToken
string

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

Status
enum<string>

Filter by active status (default: ACTIVE = only active orgs). Filter for organization active status.

Available options:
ACTIVE,
ALL,
INACTIVE
Type
enum<string>

Optional filter by organization type.

Available options:
BANK,
EMBEDDED,
PLATFORM,
TRANSACTOR,
VERTICAL_SOFTWARE_PROVIDER
ParentOrganizationId
string<uuid>

Optional filter to return only direct children of this parent organization.

OrganizationId
string<uuid>

Optional filter to return the specified organization, its children, and parent. Mutually exclusive with parentOrganizationId.

Response

Returns the list of related organizations.

Public response DTO for GET /identity/v1/organizations. Distinct from the shared OrganizationSummaryDto on purpose: the shared one carries metadata (routing number, FIS/TSYS references) that internal callers like the daily balance export job need, but no public consumer reads — keeping it off the public response keeps banking/cardholder references out of the public OpenAPI surface.

data
object[]
required

The list of organizations.

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.

parentOrganizations
null | object[]

Parent organizations of the specified organization filter. Populated when either the organizationId or parentOrganizationId query parameter is provided.

prevPaginationToken
null | string

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