Contact

List contacts

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.

get/contacts

Request

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

Query parameters

limitinteger

Maximum number of records to return

Example:10
cursorstring

Opaque cursor from a previous response's nextCursor. Omit to start from the most recent record.

searchstring

Case insensitive partial match on the contact name, account number or a contact person's email

Example:acme

Response

A page of contacts

nextCursorstring

Pass as the cursor query parameter to fetch the next page. Absent on the last page.

Example response

{
  "data": [
    {
      "id": 123,
      "name": "Acme Ltd",
      "accountingSystemId": "123",
      "contactPersons": [
        {
          "id": "00000000-0000-0000-0000-000000000123"
        }
      ],
      "groupId": 42,
      "groupTitle": "Default Group"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.