---
title: "List contacts"
method: GET
path: "/contacts/"
tags: ["Billing"]
---

# List contacts

`GET /contacts/`

Returns a paginated list of contacts. A customer is limited to seven
contacts per organisation unit (or seven without an org unit).

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `customer` string
- `orgunit` string
- `name` string
- `email` string
- `invoicing` boolean
- `collections` boolean
- `expand` string

## Headers

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

## Response `200`

Paginated contact 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` Contact[], required — The items in the current page.
    - `id` string
    - `customer` string, nullable — Customer ID this contact belongs to.
    - `orgunit` string, nullable — Organisation unit ID. Optional sub-grouping inside a customer.
    - `name` string, required
    - `email` string, email, required
    - `phone` string, nullable
    - `invoicing` boolean — Whether this contact receives invoice emails.
    - `collections` boolean — Whether this contact receives collection reminders.
    - `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/revisions/70cbc827dc7b/schema)