Retrieve a guest (legacy)
Important
A newer version of this REST API (v2.1) is available. If you're new to this REST API, use the new version. Alternatively, if you're already using the old version, read about the differences between v2 and v2.1 so you can upgrade.
GET /v2/guests/<guestRef>
Retrieves the full guest record of a guest, including any guest data extensions.
RequestResponse
curl -X GET '<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03' \
-u '<username>:<password>' \
-H 'Accept: application/json'
RequestResponse
{
"href": "<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
"ref": "f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
"createdAt": "2025-03-07T16:15:11.000Z",
"modifiedAt": "2025-08-23T16:17:16.000Z",
"firstSeen": "2025-03-07T16:15:11.000Z",
"lastSeen": "2025-08-23T16:17:16.000Z",
"guestType": "customer",
"title": "Ms",
"firstName": "Jane",
"lastName": "Doe",
"gender": "female",
"dateOfBirth": "1976-10-28T00:00:00.000Z",
"emails": [
"[email protected]"
],
"phoneNumbers": [
"0851234567"
],
"nationality": "Irish",
"passportNumber": "PZ4A9565",
"passportExpiry": "2033-01-01T00:00:00.000Z",
"street": [
"Apartment 15",
"West Drive Avenue"
],
"city": "Dublin",
"country": "IE",
"postCode": "D2",
"state": "Dublin",
"identifiers": [
{
"provider": "BXLP",
"id": "123456",
"expiryDate": "2016-08-23T16:17:16.000Z"
}
]
}