# Get an enquiry

Endpoint: GET /external-api/v1/enquiries/{id}
Version: 1.0.1
Security: apiKey

## Path parameters:

  - `id` (string, required)
    Can be either the enquiries xeniaReference or externalId.
    Example: "R4E2F3A4"

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.xeniaReference` (string, required)
    Xenia's reference for the enquiry.
    Example: "R4E2F3A4"

  - `data.clientReference` (string, required)
    The clients reference for the enquiry. This may be the same as the external ID depending on your system.
    Example: "example-ref-567abc"

  - `data.assignedSpecialist` (object,null, required)
    The assigned specialist for this resource. If this is null then no specialist has been assigned yet.

  - `data.assignedSpecialist.name` (string)
    The name of the user.
    Example: "Scott Aberdeigh"

  - `data.checkInOut` (object, required)
    The check-in and check-out dates for this enquiry. ISO-8601 date formats are accepted.

  - `data.checkInOut.checkIn` (string,null, required)
    Example: "2026-02-03"

  - `data.checkInOut.checkOut` (string,null, required)
    Example: "2026-03-10"

  - `data.enquiryLocation` (object, required)

  - `data.enquiryLocation.address` (object, required)
    The enquiries location.

  - `data.enquiryLocation.address.country` (string,null)
    The country of the location.
    Example: "United Kingdom"

  - `data.enquiryLocation.address.locality` (string,null)
    The area, neighbourhood or city of the location.
    Example: "Hackney"

  - `data.enquiryLocation.address.postalCode` (string,null)
    The postcode of the location.
    Example: "BS11 1DJ"

  - `data.enquiryLocation.address.region` (string,null)
    The region of the location.
    Example: "Somerset"

  - `data.enquiryLocation.address.streetAddress` (string,null)
    Street address of the location.
    Example: "123 fake street"

  - `data.enquiryLocation.coordinates` (object, required)
    Latitude/Longitude coordinates

  - `data.enquiryLocation.coordinates.latitude` (number, required)
    Latitude of the location.
    Example: 51.5074

  - `data.enquiryLocation.coordinates.longitude` (number, required)
    Longitude of the location.
    Example: -0.1278

  - `data.enquiryLocation.googlePlaceId` (string, required)
    The Google Place ID of the location.
    Example: "ChIJN1t_tDeuEmsRUcIaW_4C0gQ"

  - `data.enquiryState` (object,null, required)
    Metadata about the enquiry state. This is not always available and may be null.

  - `data.enquiryState.closureReason` (string,null)
    The reason for the enquiry closure. This is not always available and may be null.
    Enum: "PRICE", "AVAILABILITY", "NO_CLIENT_RESPONSE", "STAY_CANCELLED_OR_POSTPONED", "BOOKED_ELSEWHERE_COMPETITOR", "BOOKED_ELSEWHERE_DIFFERENT_PRODUCT", "DUPLICATE", "NOT_AN_ENQUIRY", "STAY_DOES_NOT_MEET_SITU_CRITERIA", "OTHER"

  - `data.enquiryState.state` (string)
    This is a machine-readable key that can be used to identify the state of the enquiry.
    Enum: "NEW", "SHORTLISTING", "QUOTED", "CLOSED", "BOOKING_PENDING", "BOOKING_CONFIRMED", "BOOKING_CHECK_IN_DETAILS_SENT", "BOOKING_CANCELLED"

  - `data.externalId` (string, required)
    The external ID of the enquiry, this is a unique value that can be used to retrieve your enquiry via other endpoints where specified.
    Example: "e234abcef"

  - `data.guestNumbers` (object, required)
    The number of guests in each category.

  - `data.guestNumbers.adults` (integer, required)
    The amount of adults (18+ years).
    Example: 2

  - `data.guestNumbers.children` (integer)
    The amount of children (1 - 17 years).
    Example: 3

  - `data.guestNumbers.infants` (integer)
    The amount of infants (0 - 1 years).
    Example: 1

  - `data.guestRequirements` (array, required)
    The guest requirements for the enquiry.

  - `data.guestRequirements.text` (string, required)
    The requirements in text format for the chosen type.
    Example: "Security guard mandatory in lobby, double locks required on apartment door"

  - `data.guestRequirements.type` (string, required)
    The type of guest requirement. For now only GENERAL is supported, but more specific types will be added in the future.
    Enum: "GENERAL"

  - `data.leadGuest` (object, required)
    Details of the lead guest.

  - `data.leadGuest.contactNumber` (string,null)
    Lead guest contact number. Must be a valid phone number format, including international formats with country codes. Valid characters are 0-9, +, -, (, ), and commas. No letters allowed.
    Example: "07556677992"

  - `data.leadGuest.email` (string,null)
    Lead guest email. Must contain exactly one @ symbol, no spaces or semicolons, and end with a valid domain (e.g., .com or .co.uk).
    Example: "Sam.Smith@example.com"

  - `data.leadGuest.familyName` (string,null)
    Lead guest family name (surname).
    Example: "Smith"

  - `data.leadGuest.givenName` (string,null)
    Lead guest given name (first name).
    Example: "Sam"

  - `data.clientBooker` (object, required)
    Details of the Booker for the enquiry or booking.

  - `data.clientBooker.contactNumber` (string,null, required)
    Booker contact number
    Example: "+447911992499"

  - `data.clientBooker.email` (string, required)
    Booker email
    Example: "Jess.Walters@example.com"

  - `data.clientBooker.familyName` (string, required)
    Booker family name
    Example: "Walters"

  - `data.clientBooker.givenName` (string, required)
    Booker given name
    Example: "Jess"

  - `data.createdAt` (string, required)
    ISO-8601 UTC timestamp. The example is the expected format.
    Example: "2026-01-01T15:12:56Z"

## Response 404 fields (application/problem+json):

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "The request could not be understood due to malformed syntax."

  - `instance` (string)
    A URI reference or identifier that describes the specific occurrence of the problem.
    Example: "/api/v1/enquiries/abc"

  - `status` (integer, required)
    The HTTP status code.
    Example: 400

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "Bad Request"

  - `type` (string, required)
    The error code as a machine-readable key.
    Enum: "RESOURCE_NOT_FOUND", "VALIDATION_ERROR", "RESOURCE_ALREADY_EXISTS", "DUPLICATE_CLIENT_REFERENCE", "GEOCODE_FAILURE", "MALFORMED_REQUEST", "INTERNAL_SERVER_ERROR", "MAX_RESOURCE_COUNT_REACHED", "SANDBOX_SPECIFIC_ACTION_ERROR"


## Response 401 fields

## Response 403 fields