Bathrooms

Overview

This resource represents the rental's bathrooms. This resource is mostly static information used for presentational purposes.

Parameters

OAuth Scopes:

public

Name	Type	Read/Write	Description
account	Integer	Read	Account's ID related to the Bathroom
rental	Integer	Read	Rental's ID related to the Bathroom
id	Integer	Read	Bathroom's id.
name	Object	Read	Bathroom's name, list of locales described in enums section.
bath_count	Integer	Read	Bathroom's number of baths.
shower_count	Integer	Read	Bathroom's number of showers.
wc_count	Integer	Read	Bathroom's number of wc's.
created_at	Time	Read	Bathroom's create time.
updated_at	Time	Read	Bathroom's update time.

rentals_write

Name	Type	Read/Write	Description	Constraints
account	Integer	Read	Account's ID related to the Bathroom
rental	Integer	Read	Rental's ID related to the Bathroom
id	Integer	Read	Bathroom's id
name	Object	Read	Bathroom's name, list of locales described in enums section
name_locale	String	Write	Bathroom's name, used in write operations. Replace the locale with one of the locales described in enums section (e.g. name_en). Multiple of these attributes could be passed in the same operation, as long as they each have a unique locale (e.g name_en and name_fr)	Required for Account's default locale, maximum length: 25
bath_count	Integer	Read/Write	Bathroom's number of baths	integer only, greater than or equal to: 0
shower_count	Integer	Read/Write	Bathroom's number of showers	integer only, greater than or equal to: 0
wc_count	Integer	Read/Write	Bathroom's number of wc's	integer only, greater than or equal to: 0
created_at	Time	Read	Bathroom's create time
updated_at	Time	Read	Bathroom's update time

List bathrooms

List all bathrooms for a given account.

GET /bathrooms

OAuth Scopes:

public

response.json

{
  "links": {
    "bathrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bathrooms.rental}"
  },
  "bathrooms": [
    {
      "links": {
        "rental": 1
      },
      "id": 1,
      "name": {
        "en": "bathroom"
      },
      "bath_count": 1,
      "shower_count": 0,
      "wc_count": 2,
      "created_at": "2025-03-31T17:52:09.483Z",
      "updated_at": "2025-04-07T17:52:09.483Z"
    }
  ],
  "meta": {}
}

Get a single bathroom

Returns a single bathroom identified by ID.

GET /bathrooms/:bathroom_id

OAuth Scopes:

public

response.json

{
  "links": {
    "bathrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bathrooms.rental}"
  },
  "bathrooms": [
    {
      "links": {
        "rental": 1
      },
      "id": 1,
      "name": {
        "en": "bathroom"
      },
      "bath_count": 1,
      "shower_count": 0,
      "wc_count": 2,
      "created_at": "2025-03-31T17:52:09.485Z",
      "updated_at": "2025-04-07T17:52:09.485Z"
    }
  ],
  "meta": {}
}

Create a new bathroom

Creates a bathroom for given rental.

POST /rentals/:rental_id/bathrooms

OAuth Scopes:

rentals_write

request.json

{
  "bathrooms": [
    {
      "name_en": "bathroom",
      "bath_count": 1,
      "shower_count": 0,
      "wc_count": 2
    }
  ]
}

response.json

{
  "links": {
    "bathrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bathrooms.rental}"
  },
  "bathrooms": [
    {
      "links": {
        "rental": 1
      },
      "id": 1,
      "name": {
        "en": "bathroom"
      },
      "bath_count": 1,
      "shower_count": 0,
      "wc_count": 2,
      "created_at": "2025-03-31T17:52:09.488Z",
      "updated_at": "2025-04-07T17:52:09.488Z"
    }
  ],
  "meta": {}
}

Update a bathroom

Returns an updated bathroom identified by ID.

PUT /bathrooms/:bathroom_id

OAuth Scopes:

rentals_write

request.json

{
  "bathrooms": [
    {
      "name_en": "bathroom",
      "bath_count": 1,
      "shower_count": 0,
      "wc_count": 2
    }
  ]
}

response.json

{
  "links": {
    "bathrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bathrooms.rental}"
  },
  "bathrooms": [
    {
      "links": {
        "rental": 1
      },
      "id": 1,
      "name": {
        "en": "bathroom"
      },
      "bath_count": 1,
      "shower_count": 0,
      "wc_count": 2,
      "created_at": "2025-03-31T17:52:09.490Z",
      "updated_at": "2025-04-07T17:52:09.490Z"
    }
  ],
  "meta": {}
}

Destroy a bathroom

Required OAuth scope: :rentals_write

Returns an empty response with 204 No Content status code on success.

DELETE /bathrooms/:bathroom_id