Sign in
Contacts

Get a contact

Retrieve the details of a single contact (required scope contacts:read)

get/v1/contacts/{contactId}

Path parameters

contactIdinteger required

The unique identifier of the contact

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the contact

createdAtstring date-time

The UTC timestamp of when this contact was created

modifiedAtstring date-time

The UTC timestamp of when this contact was modified

referencestring

The internal reference of the contact - should usually be unique

namestring

The name of the contact

groupIdinteger

The unique identifier of the group this contact belongs to

parentIdinteger nullable

The unique identifier of the parent contact of this contact

extraInformationstring

A free text description about the contact

streetstring

The contact street address

townstring

The contact address town / city / village / locality

postalCodestring

The contact address postcode or zipcode

countrystring

The textual name of the contact address country

accountStatus'normal' | 'contactOnStop' | 'creditLimitOnStop'

The status of the contact (if they are on stop)<p>Possible values:</p><ul><li><b>normal</b>: Normal</li><li><b>contactOnStop</b>: Contact is on stop</li><li><b>creditLimitOnStop</b>: Credit limit is on stop</li></ul>

stopReasonstring

If the contact status has been set to on stop, a textual description explaining why

stoppedAtstring date nullable

The date that this contact was placed on stop

Example response

{
  "id": 5514123,
  "createdAt": "2022-11-29T16:50:16.0000000+00:00",
  "modifiedAt": "2023-09-12T11:24:23.0000000+00:00",
  "reference": "5514123",
  "name": "Example Company",
  "groupId": 5514123,
  "parentId": 5514123,
  "extraInformation": "Loyal customer for many years",
  "street": "3150 Century Way",
  "town": "Leeds",
  "postalCode": "LS15 6HU",
  "country": "England",
  "location": {
    "latitude": 51.31349,
    "longitude": -0.7464233
  },
  "accountStatus": "normal",
  "stopReason": "This customer has not paid for our services and won't return calls",
  "stoppedAt": "2023-09-12",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "Purple",
      "definition": {
        "caption": "Favourite colour",
        "type": "boolean",
        "listOptions": [
          "Red",
          "Blue",
          "Green",
          "Purple"
        ],
        "isRequired": true,
        "isEditable": true,
        "default": "10"
      },
      "systemListValueMetadata": {
        "label": "John Doe",
        "entityType": "resource"
      }
    }
  ]
}