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

# List contacts

`GET /contacts`

## Request

- Base URL: `https://api.paidnice.com/rest/v1`
- URL: `https://api.paidnice.com/rest/v1/contacts`
- Auth: HTTP bearer

Returns contacts for the authenticated organisation, most recently created first. Use search to find a contact by name, account number or contact person email, then use its id with the other contact and invoice operations.

## Query parameters

- `limit` integer: Maximum number of records to return
- `cursor` string: Opaque cursor from a previous response's nextCursor. Omit to start from the most recent record.
- `search` string: Case insensitive partial match on the contact name, account number or a contact person's email

## Response `200`

A page of contacts

- object
  - `data` Contact[], required
    - `id` integer, required
    - `name` string, required
    - `accountingSystemId` string, required
    - `status` 'ACTIVE' | 'ARCHIVED', required
    - `accountNumber` string
    - `smsOptedOut` boolean, required
    - `contactPersons` object[], required
      - `id` string, uuid, required
      - `isPrimary` boolean, required
      - `firstName` string
      - `lastName` string
      - `email` string
      - `mobileNumber` string
      - `mobileNumberCountryCode` string
      - `defaultNumber` string
      - `defaultNumberCountryCode` string
      - `includeInNotifications` boolean, required
      - `sourceType` 'imported' | 'local', required
    - `groupId` integer, required
    - `groupTitle` string, required
  - `nextCursor` string: Pass as the cursor query parameter to fetch the next page. Absent on the last page.

## Other responses

- `400`: Invalid request
- `401`: Missing or invalid API key
- `403`: The public API is not enabled for the organisation, or the API key lacks the required scope
- `429`: Too many requests

---

[API](https://skmtc.dev/paidnice/apis/paidnice-public-api.md) · [All operations](https://skmtc.dev/paidnice/apis/paidnice-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paidnice/apis/paidnice-public-api/revisions/d4911087b8e7?raw)