v1

latestOpenAPI 3.0.1Apache 2.02026-07-26131220353.8 KB
Companies

Search for Companies

Use this endpoint to search for companies associated with a specific organisation.

get/v1/companies

Query parameters

organization_idstring uuid

Enter the organization ID of the companies you are searching for. Ensure that the access token used for authentication has the correct permissions to search for companies in the given organization.

beforestring

Lower bound of the page of data to return (cannot be used together with [after] or [offset]).

afterstring

Upper bound of the page of data to return (cannot be used together with [before] or [offset]).

offsetinteger

Offset of the page of data to return (cannot be used together with [before] or [after]).

limitinteger

The maximum amount of items to return.

sorting_keysstring[]

The keys to sort the results by.

sorting_orderPageOrder[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.

Response

Company search successful