v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB

Billing

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/

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

orgunitstring

namestring

emailstring

invoicingboolean

collectionsboolean

expandstring

Pass orgunit to expand the orgunit relation inline.

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.

Paginated contact 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.

{
  "count": 142,
  "results": [
    {
      "id": "con_01H8XYZ123ABC"
    }
  ]
}

All 236 operations