Guests

Scope

Property Get / Property Set

Get Guests

Endpoint

GET https://yourdomain.com/bookyflow/api/guests/{{property_id}}/list

Returns all guests for a particular property

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "listguests": [
      {
        "guests_uid": 3,
        "firstname": "qwer",
        "surname": "qwer",
        "house": "qwer",
        "street": "qwer",
        "town": "qwer",
        "county": "786",
        "country": "DE",
        "postcode": "qwer",
        "tel_landline": "qwer",
        "tel_mobile": "qwer",
        "email": "qwer@test.com",
        "vat_number": "",
        "discount": 0,
        "property_uid": "1"
      },
      {
        "guests_uid": 5,
        "firstname": "partner",
        "surname": "partner",
        "house": "asdf",
        "street": "asdf",
        "town": "asdf",
        "county": "786",
        "country": "DE",
        "postcode": "asdf",
        "tel_landline": "asdf",
        "tel_mobile": "asdf",
        "email": "partner@bookyflow.net",
        "vat_number": "",
        "discount": 0,
        "property_uid": "1"
      },
      {
        "guests_uid": 6,
        "firstname": "asdf",
  ...
  (Response truncated for brevity)
}

Add guest

Endpoint

POST https://yourdomain.com/bookyflow/api/guests/{{property_id}}/{{guest_firstname}}/{{guest_surname}}/{{guest_house}}/{{guest_street}}/{{guest_town}}/{{guest_region}}/{{guest_country}}/{{guest_postcode}}/{{guest_landline}}/{{guest_mobile}}/{{guest_email}}/{{guest_vat_number}}/{{guest_discount}}/

While VAT number is included in the query, it is not currently stored, leave it and discount blank if required.

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{guest_firstname}} (Required parameter)
{{guest_surname}} (Required parameter)
{{guest_house}} (Required parameter)
{{guest_street}} (Required parameter)
{{guest_town}} (Required parameter)
{{guest_region}} (Required parameter)
{{guest_country}} (Required parameter)
{{guest_postcode}} (Required parameter)
{{guest_landline}} (Required parameter)
{{guest_mobile}} (Required parameter)
{{guest_email}} (Required parameter)
{{guest_vat_number}} (Required parameter)
{{guest_discount}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "addguest": [
      {
        "guest_uid": "16"
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Modify guest

Endpoint

PUT https://yourdomain.com/bookyflow/api/guests/{{property_id}}/{{guest_id}}/{{guest_firstname}}/{{guest_surname}}/{{guest_house}}/{{guest_street}}/{{guest_town}}/{{guest_region}}/{{guest_country}}/{{guest_postcode}}/{{guest_landline}}/{{guest_mobile}}/{{guest_email}}/{{guest_vat_number}}/{{guest_discount}}/

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{guest_id}} (Required parameter)
{{guest_firstname}} (Required parameter)
{{guest_surname}} (Required parameter)
{{guest_house}} (Required parameter)
{{guest_street}} (Required parameter)
{{guest_town}} (Required parameter)
{{guest_region}} (Required parameter)
{{guest_country}} (Required parameter)
{{guest_postcode}} (Required parameter)
{{guest_landline}} (Required parameter)
{{guest_mobile}} (Required parameter)
{{guest_email}} (Required parameter)
{{guest_vat_number}} (Required parameter)
{{guest_discount}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "updateguest": [
      {
        "property_uid": "1",
        "guests_uid": "16"
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Delete guest

Endpoint

DELETE https://yourdomain.com/bookyflow/api/guests/{{property_id}}/{{guest_id}}/

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{guest_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "deleteguest": [
      {
        "message": "_BOOKYFLOW_MR_AUDIT_DELETE_GUEST",
        "property_uid": "1",
        "guests_uid": "16"
      }
    ]
  },
  "meta": {
    "code": 200
  }
}