Skip to main content
GET
/
identity
/
v1
/
organizations
Lists organizations that have a relationship with the caller's organization.
curl --request GET \
  --url https://api.sandbox.tesouro.com/identity/v1/organizations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "detailsUrl": "<string>",
      "displayName": "<string>",
      "isEnabled": true,
      "types": [
        "BANK"
      ]
    }
  ],
  "nextPaginationToken": "<string>",
  "parentOrganizations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "displayName": "<string>",
      "isEnabled": true,
      "types": [
        "BANK"
      ]
    }
  ],
  "prevPaginationToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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.

Response DTO for listing related organizations.

​
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. An organization can have multiple parents (graph structure). Contains only non-sensitive fields.

​
prevPaginationToken
null | string

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