Retrieve Contact
Last updated
Was this helpful?
Last updated
Was this helpful?
This endpoint retrieves detailed information about a specific contact.
POST
app-id
string
Yes
Your application ID. Required for authentication.
Authorization
string
Yes
Your API key for authorization.
Content-Type
string
Yes
Must be set to application/json
.
hotel_id
alphanumeric (Required)
The unique property ID as assigned by the provider upon creation of the property.
channel_hotel_id
string (Required)
The unique id for the legal entity associated with the hotel. the unique ID of the property on channel to retrieve its details.
Status
string
The status of the response.
Data
object
The response data, the root element.
contacts array
An array of contact objects containing contact details.
contact_profiles array
A list of profiles associated with the contact (for example, invoices, general).
address object
Contains the address details of the contact including country, city and postal code details.
city_name
string
The city name where the contact is located.
country_code
enumerated string
The ISO country code of the contact's location.
postal_code
string
The postal code of the contact's location.
address_line
string
The street address of the contact.
language_code
enumerated string
The language code for the address.
contact_person object
Details about the contact person.
gender
enumerated string
Gender of the contact person.
name
string
Full name of the contact person.
job_title
enumerated string
Job title of the contact person.
language_code
string
Language code for the contact person (for example, 'en-gb').
phones
array
List of phone numbers associated with the contact.
phone_number
string
The actual phone number (all international phone numbers).
phone_tech_type
enumerated string
Technology type of the phone (for example, '1' for landline).
extension
string
Extension number for the phone, if applicable.
email
string
Email address of the contact.
Error
array
Array that contains details about any errors that occurred during the API call. Each object in the Errors
array contains the following properties:
Code
string
Specific error code that helps identify the type of error.
ShortText
string
Brief description of the error.