Contact

Get contact

Returns a contact by id.

get/contact/{id}

Request

  • Base URL: https://api.paidnice.com/rest/v1
  • URL: https://api.paidnice.com/rest/v1/contact/{id}
  • Auth: HTTP bearer

Path parameters

idinteger nullable
Example:123

Response

The contact

idinteger required
namestring required
accountingSystemIdstring required
status'ACTIVE' | 'ARCHIVED' required
accountNumberstring
smsOptedOutboolean required
groupIdinteger required
groupTitlestring required

Example response

{
  "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.