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.
Headers
The type of media of the resource. Recommended value is application/json.
A unique identifier used to trace and track each request.
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>
Query Parameters
The maximum number of items to include in the response. Max: 100
1 <= x <= 100The 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.
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.
The order used to sort the results.
asc, desc The number of the page that you want to retrieve.
x >= 1Filter by metadata using dot-notation. Replace key with your metadata field name (e.g. metadata.costCenter=BR_11101997).
Filter organizations by legal name. Uses prefix matching (case-insensitive, max 256 characters).
256Filter organizations by trade name (doing business as). Uses prefix matching (case-insensitive, max 256 characters).
256Filter organizations by status. Accepted values are ACTIVE or INACTIVE (uppercase, exact match).
ACTIVE, INACTIVE Filter organizations by legal document number (exact match).

