Read Function event

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.function_event/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_event/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

One booked use of a function space — a meeting, a reception, a dinner — on a date, in a window, in a setup style, with the expected / guaranteed / set / actual attendance. tentative holds the diary and commits nothing; definite is contracted; actual is recorded after the function with the attendance the banquet charges bill on; cancelled is terminal. The events of a group hang off its block through function_event_for_block.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.function_event: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_event

properties

required

object

actual_count

Actual attendance, recorded after the function

integer

do_not_move

required

The client was promised this room; reschedule refuses a space change

boolean

end_at

required

Doors close

string format: date-time

event_date

required

The property-local day the event is on

string format: date

event_type

required

What kind of function

string

Allowed values: meeting conference breakout reception breakfast lunch dinner banquet wedding_ceremony wedding_breakfast exhibition rehearsal other

expected_count

required

Expected attendance (the forecast number)

integer

guarantee_due_at

When the guarantee is due; after it the number may only rise

string format: date-time

guaranteed_count

Guaranteed attendance — the contracted minimum the client bills on

integer

required

Event id

string

name

required

Event name

string

notes

Notes for the operating departments

string

rental

Function event rental

Function space rental agreed for the event

object

amount

required

string format: decimal

currency

required

string format: iso-4217

set_count

How many the room was set for

integer

setup_from

When the setup crew may have the room (before start_at)

string format: date-time

setup_style

required

How the room is set

string

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

start_at

required

Doors open

string format: date-time

status

required

Event status

string

Allowed values: tentative definite actual cancelled

teardown_until

When the room must be clear again (after end_at)

string format: date-time

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_event",
  "properties": {
    "event_type": "meeting",
    "setup_style": "theatre",
    "status": "tentative"
  },
  "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).