---
title: "List organisation units"
method: GET
path: "/orgunits/"
tags: ["Billing"]
---

# List organisation units

`GET /orgunits/`

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.

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `customer` string
- `name` string

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated org-unit list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` Orgunit[], required — The items in the current page.
    - `id` integer
    - `customer` string, required — Customer ID this org unit belongs to.
    - `name` string, required
    - `created` string, date-time
    - `updated` string, date-time

## Other responses

- `401` — Authentication credentials missing or invalid.

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/versions/70cbc827dc7b/schema)