v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB

Billing

List organisation units

Returns a paginated list of organisation units. A customer can have at most twelve org units; org units are an optional sub-grouping for contacts and subscriptions.

get/orgunits/

Query parameters

pageinteger

Page number to retrieve (1-indexed).

page_sizeinteger

Number of items per page.

orderingstring

Field to sort results by. Prefix with - for descending order (e.g. -created).

customerstring

namestring

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Response

Paginated org-unit list.

countinteger required

Total number of items matching the filter.

nextstring uri nullable

URL of the next page, or null if last page.

previousstring uri nullable

URL of the previous page, or null if first page.

Example response

{
  "count": 142
}