Get a person
Retrieve the details of a single person (required scope contacts:persons:read)
Path Parameters
The unique identifier of the person
Header Parameters
The customer identifier
- 200
- 400
- 403
- 404
- 500
Success
Schema
- Array [
- boolean: Indicates a boolean field (Example: "false")
- integer: Indicates an integer numeric field (Example: "1001")
- decimal: Indicates a floating point numeric field (Example: "1.42")
- text: Indicates an editable text field (Example: "Purple")
- list: Indicates a field with a single value from a predefined list of options (Example: "Purple")
- statement: Indicates a text field that cannot be edited. The value is always equal to the default value (Example: "By signing this you agree to the following...")
- date: Indicates a date field, which will be represented as an RFC3339 formatted date string. The default value is not supported for this type and will always be null (Example: "2024-01-31")
- note: Indicates a multiline, editable text field. Lines are seperated with a line feed character (Example: "This is a note.")
- time: Indicates a time field, formatted as HH:mm. The default value is not supported for this type and will always be null (Example: "10:30")
- systemList: Indicates the ID of a related resource, vehicle or web user (Example: "228007")
- resource
- vehicle
- webUser
- ]
The unique identifier of the person
The UTC timestamp of when this person was created
The unique identifier of the contact that this person belongs to
The person's title
The person's first name
The person's second name
The email address of the person
The mobile telephone number of the person
The landline telephone number of the person
The landline extension of the person
The job role that the person holds within the contact
The department that the person belongs to
A flag indicating if the contact has opted out of marketing communications
customFields object[]
Custom fields associated with persons
The unique identifier of the associated custom field definition
The current value set for the custom field
definition object
Represents the definition of a custom field
The caption of a custom field
Possible values: [boolean, integer, decimal, text, list, statement, date, note, time, systemList]
The type of the custom field. New field types may be added in the future, so integrations should be resilient to this
Possible values:
Shows the possible values for a list type custom field. Value will be null if type is not list
Indicates if the field is required in the UI. This is NOT enforced in the API
Indicates if the field is editable
The default value of a custom field. Formatted in accordance with the rules of the field type
systemListValueMetadata object
Represents details of custom field value of type system list
A descriptive label for the specific resource, vehicle or web user that this system list value relates to
Possible values: [resource, vehicle, webUser]
The type of entity used for custom field value of type system list
Possible values:
{
"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",
"isOptedOut": false,
"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"
}
}
]
}
Bad Request
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Forbidden
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Not Found
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Server Error
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}