reservations

Get a reservation

Returns a single reservation with its status and companies.

GET

/v1/reservations/{id}

Get a reservation

curl --request GET \
  --url https://api.beamdynamics.io/v1/reservations/{id} \
  --header 'beam-api-key: <api-key>'

{
  "company": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "createdAt": "<string>",
  "createdById": "<string>",
  "customFields": {},
  "defaultTimezone": "<string>",
  "description": "<string>",
  "endDate": "<string>",
  "id": 123,
  "seqId": 123,
  "startDate": "<string>",
  "status": {
    "category": "open",
    "color": "<string>",
    "description": "<string>",
    "id": "<string>",
    "name": "<string>"
  },
  "statusId": "<string>",
  "studioId": "<string>",
  "title": "<string>",
  "updatedAt": "<string>",
  "url": "<string>"
}

Authorizations

beam-api-keystringheaderrequired

Path Parameters

idintegerrequired

Required range: 0 < x

Response

The reservation

companyobject[]required

Companies linked to the reservation

Show child attributes

createdAtstringrequired

Creation timestamp (ISO 8601)

createdByIdstring | nullrequired

Id of the user who created the reservation

customFieldsobjectrequired

Custom field values of the reservation, keyed by custom field id

defaultTimezonestring | nullrequired

Default IANA timezone of the reservation

descriptionstring | nullrequired

Reservation description

endDatestringrequired

End date and time (ISO 8601)

idintegerrequired

Reservation id

seqIdintegerrequired

Sequential reservation number within the studio

startDatestringrequired

Start date and time (ISO 8601)

statusobjectrequired

Current status of the reservation

Show child attributes

statusIdstringrequired

Id of the reservation status

studioIdstringrequired

Id of the studio that owns the reservation

titlestringrequired

Reservation title

updatedAtstringrequired

Last update timestamp (ISO 8601)

urlstringrequired

Link to the reservation in the Beam web app

Still need help? Ask the team