BObookingexperts
Reservation Guests

GET guests

Changed on

Returns all known guests for the specified reservation

get/v3/administrations/{administration_id}/reservations/{reservation_id}/guests

Request

Path parameters

reservation_idstring required

Reservation ID

administration_idstring required

Administration ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, created_at, updated_at

fields[guest]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[first_name]string

Filter on first_name

filter[last_name]string

Filter on last_name

filter[email]string

Filter on email

filter[profession]string

Filter on profession

filter[phone]string

Filter on phone

filter[country_code]string

Filter on country_code

filter[country_code_of_origin]string

Filter on country_code_of_origin

filter[date_of_birth]string

Filter on date_of_birth

filter[address]string

Filter on address

filter[city]string

Filter on city

filter[postal_code]string

Filter on postal_code

filter[province]string

Filter on province

filter[municipality]string

Filter on municipality

filter[document_type]string

Filter on document_type

filter[document_number]string

Filter on document_number

filter[document_issue_date]string

Filter on document_issue_date

filter[visa_number]string

Filter on visa_number

filter[signature]string

Filter on signature

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[reservation]string

Filter on reservation. Specify a comma separated list of IDs to filter on.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

GuestCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "guest",
      "attributes": {
        "country_code": "NL",
        "country_code_of_origin": "NL"
      },
      "relationships": {
        "reservation": {
          "data": {
            "type": "reservation"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "reservation",
      "attributes": {
        "payment_guarantee": "none",
        "price_according_to_channel_calculation": "total",
        "license_plates": [
          "75-DN-GP"
        ],
        "currency": "EUR",
        "checkin_time": "14:00",
        "checkout_time": "10:00",
        "access_code": "1337",
        "stay_reason": "tourism, business"
      },
      "relationships": {
        "category": {
          "data": {
            "type": "category"
          }
        },
        "rentable_type": {
          "data": {
            "type": "rentable_type"
          }
        },
        "rentable_identity": {
          "data": {
            "type": "rentable_identity"
          }
        },
        "inventory_object": {
          "data": {
            "type": "inventory_object"
          }
        },
        "booking": {
          "data": {
            "type": "booking"
          }
        },
        "order": {
          "data": {
            "type": "order"
          }
        },
        "discount_card": {
          "data": {
            "type": "discount_card"
          }
        },
        "primary_package": {
          "data": {
            "type": "primary_package"
          }
        },
        "extra_packages": {
          "data": [
            {
              "type": "extra_package"
            }
          ]
        },
        "extra_order_items": {
          "data": [
            {
              "type": "extra_order_item"
            }
          ]
        },
        "cancellation_rules": {
          "data": [
            {
              "type": "cancellation_rule"
            }
          ]
        },
        "reservation_amenities": {
          "data": [
            {
              "type": "reservation_amenity"
            }
          ]
        },
        "available_optional_amenities": {
          "data": [
            {
              "type": "amenity"
            }
          ]
        },
        "labels": {
          "data": [
            {
              "type": "label"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "discount_action": {
          "data": {
            "type": "discount_action"
          }
        },
        "order_items": {
          "data": [
            {
              "type": "order_item"
            }
          ]
        },
        "main_order_items": {
          "data": [
            {
              "type": "main_order_item"
            }
          ]
        },
        "available_discount_cards": {
          "data": [
            {
              "type": "discount_card"
            }
          ]
        },
        "available_primary_packages": {
          "data": [
            {
              "type": "primary_package"
            }
          ]
        },
        "available_extra_packages": {
          "data": [
            {
              "type": "extra_package"
            }
          ]
        },
        "available_extras": {
          "data": [
            {
              "type": "extra"
            }
          ]
        },
        "question_answers": {
          "data": [
            {
              "type": "question_answer"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////// to the response with the status