For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get list of Room Type Options API

List room type options

get
/room_types/options

List room types as lightweight options (id, title, occupancy, display position, photo, property) for selectors. Not paginated; accepts the same property filter and ordering keys as the list.

Authorizations
user-api-keystringRequired

API key for programmatic access, sent in the user-api-key header.

Query parameters
filter[property_id]string · uuidOptional

Return only room types of this property.

Example: 716305c4-561a-4561-a187-7f5b8aeb5920
order[title]string · enumOptional

Sort direction for list results.

Possible values:
order[position]string · enumOptional

Sort direction for list results.

Possible values:
order[inserted_at]string · enumOptional

Sort direction for list results.

Possible values:
Responses
200

The request has succeeded.

application/json

A plain data-array envelope without pagination — used by reference/dictionary endpoints.

get/room_types/options
GET /api/v1/room_types/options HTTP/1.1
Host: app.channex.io
user-api-key: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "type": "room_type",
      "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
      "attributes": {
        "id": "994d1375-dbbd-4072-8724-b2ab32ce781b",
        "title": "Standard Room",
        "occ_adults": 3,
        "occ_children": 0,
        "occ_infants": 0,
        "default_occupancy": 2,
        "position": 0,
        "photo": "https://images.channex.io/cce1fbdb-e7be-4804-1f71-f7617cb7cc00/",
        "property_id": "2941337f-50d6-4189-ae13-f76efaf9c515"
      }
    }
  ]
}

Last updated