Sign in
Organizations

List Organizations

Returns a list of organizations. You can filter by status or VAT ID to find specific organizations. You can use the limit, page, sortBy and sortDirection parameters to filter and sort the results.

get/organizations

Query parameters

status'ONBOARDING_STARTED' | 'ONBOARDING_RISK_AND_COMPLIANCE' | 'ONBOARDING_MANDATES_AND_TERMS' | 'ACTIVE' | 'DEACTIVATED' | 'CANCELLED'

The status of the organization, see our guides for more details.

Example:ONBOARDING_STARTED

The status of the organizations to filter by.

vatIdstring

The VAT ID of the organization to filter by.

limitinteger

The maximum number of items to return per page. The default value if not provided is 100, the maximum allowed value is 1000.

pageinteger

The page number to return, starting with 0, this counts up to the total number of pages. The total number of pages is determined by the total number of records divided by the limit.

sortBy'id' | 'name' | 'status' | 'createdAt'

The field to sort by.

sortDirection'ASC' | 'DESC'

The direction to sort by.

Response

Ok

hasNextPageboolean

Indicates whether there is a next page available.

Changes

No recorded changes to this endpoint across all 1 revision of this API.