Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Organizations API

List Organizations

Use this endpoint to retrieve the details of all the Organizations you have created.

Note: the metadata filter is mutually exclusive with the legal_name and doing_business_as filters. Combining metadata with either of them returns a 400 error.

get/v1/organizations

Query parameters

limitinteger

The maximum number of items to include in the response. Max: 100

start_datestring

The beginning of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.

end_datestring

The end of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.

sort_order'asc' | 'desc'

The order used to sort the results.

pageinteger

The number of the page that you want to retrieve.

metadata.keystring

Filter by metadata using dot-notation. Replace key with your metadata field name (e.g. metadata.costCenter=BR_11101997).

legal_namestring

Filter organizations by legal name. Uses prefix matching (case-insensitive, max 256 characters).

doing_business_asstring

Filter organizations by trade name (doing business as). Uses prefix matching (case-insensitive, max 256 characters).

status'ACTIVE' | 'INACTIVE'

Filter organizations by status. Accepted values are ACTIVE or INACTIVE (uppercase, exact match).

legal_documentstring

Filter organizations by legal document number (exact match).

Headers

Content-Typestring

The type of media of the resource. Recommended value is application/json.

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Response

Indicates that the request was successful and the response contains the expected data.

pageinteger

The number of pages returned.

limitinteger

The maximum number of items included in the response.

Example response

{
  "items": [
    {
      "legalDocument": "123456789012345"
    }
  ]
}