Read Function space

GET

/v1/object-types/hospitality.function_space/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.function_space/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.function_space/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

A bookable function room at a property — what the house sells by the hour. capacities declares how many the room holds per setup style, and a booking is checked against the style it asks for. A divisible room is one space with sections linked through function_space_section_of: an event in the combined room occupies every section, and a booked section blocks the whole.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.function_space:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.function_space

properties

required

object

area_sqm

Floor area in square metres

string format: decimal

capacities

required

Function space capacities

Capacity per setup style

Array<object>

object

capacity

required

integer

setup_style

required

string

Allowed values: theatre classroom boardroom u_shape hollow_square banquet_rounds cabaret reception exhibition existing

code

required

Operator-facing code

string

divisible

required

Whether the room splits into sections

boolean

required

Function space id

string

location

Where in the house (floor, wing)

string

name

required

Display name

string

notes

Operational notes (access, power, ceiling height)

string

status

required

Space status

string

Allowed values: active out_of_service retired

provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object

pins

object

key

additional properties

object

pinned_at

string format: date-time

pinned_by

object

reason

required

string

properties

object

key

additional properties

object

external_id

string

recorded_at

required

string format: date-time

source

required

string

source_updated_at

string format: date-time

stream

string

scope

required

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer

>= 1

Example

{
  "object_type": "hospitality.function_space",
  "properties": {
    "capacities": [
      {
        "setup_style": "theatre"
      }
    ],
    "status": "active"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).