Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Persons

Get a person

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

get/v1/persons/{personId}

Path parameters

personIdstring uuid required

The unique identifier of the person

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idstring uuid

The unique identifier of the person

createdAtstring date-time

The UTC timestamp of when this person was created

contactIdinteger

The unique identifier of the contact that this person belongs to

titlestring

The person's title

forenamestring

The person's first name

surnamestring

The person's second name

emailstring

The email address of the person

mobilestring

The mobile telephone number of the person

landlinestring

The landline telephone number of the person

extensionstring

The landline extension of the person

positionstring

The job role that the person holds within the contact

departmentstring

The department that the person belongs to

isOptedOutboolean

A flag indicating if the contact has opted out of marketing communications

isMainboolean

A flag indicating if this person is the primary person for the contact

flagIdsinteger[]

The IDs of flags currently applied to this person

Example response

{
  "id": "5514123",
  "createdAt": "2022-11-29T16:50:16.0000000+00:00",
  "contactId": 12345,
  "title": "Mr",
  "forename": "David",
  "surname": "Smith",
  "email": "dave.brown@example.com",
  "mobile": "+447812 123112",
  "landline": "+441312 112441",
  "extension": "12",
  "position": "Manager",
  "department": "Customer service",
  "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"
      }
    }
  ]
}