List contacts

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

GET /contacts

List contacts

cURL

curl --request GET \
  --url https://api.piriod.com/contacts/ \
  --header 'Authorization: <api-key>' \
  --header 'x-simple-workspace: <x-simple-workspace>'

200

{
  "count": 142,
  "results": [
    {
      "name": "<string>",
      "email": "[e-mail]",
      "id": "con_01H8XYZ123ABC",
      "customer": "<string>",
      "orgunit": "<string>",
      "phone": "<string>",
      "invoicing": true,
      "collections": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

Authorization · string · header · required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace · string · required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode · boolean · default: false

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

Query Parameters

page · integer · default: 1

Page number to retrieve (1-indexed).

Required range: x >= 1

page_size · integer · default: 20

Number of items per page.

Required range: 1 <= x <= 100

ordering · string

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

customer · string

orgunit · string

name · string

email · string

invoicing · boolean

collections · boolean

expand · string

Pass orgunit to expand the orgunit relation inline.

Response

200

application/json

Paginated contact list.

count · integer · required

Total number of items matching the filter.

Example:

142

results · object[] · required

The items in the current page.

Show child attributes

next · string<uri> | null

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

previous · string<uri> | null

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