Reference Data

Many write endpoints require numeric IDs — statusTypeId, itemTypeId, venueCategoryId, colorId, roomType, and so on. These endpoints return them, so you never have to hardcode or guess.

Start with GET /v1/reference/types. It returns every lookup table in one call and covers almost everything. Fetch it once and cache it for the life of your process — these values change very rarely.

Each lookup is gated by the read scope of the resource that consumes it, so a narrow integration never gains unrelated access.

All lookup types

GET /v1/reference/types

Scope: tours.read Query parameters

Name	Type	Default	Description
`limit`	number	uncapped	How many tables to return.
`offset`	number	`0`	Where to start.

The default returns all tables — there is no need to page, and you should not pass a limit matching today’s table count. Doing so would silently drop any table added later. Example

curl "$BASE/v1/reference/types" \
  -H "x-api-key: $KEY" -H "x-api-secret: $SECRET" -H "Authorization: Bearer $TOKEN"

Response data

{
  "types": [
    {
      "name": "statusTypes",
      "type": [
        { "id": 1, "type": "Confirmed", "description": "This item is confirmed" },
        { "id": 2, "type": "Unconfirmed", "description": "This item is unconfirmed" }
      ]
    },
    {
      "name": "avatarColors",
      "type": [
        { "id": 1, "type": "gray", "description": "gray" },
        { "id": 2, "type": "red", "description": "red" }
      ]
    }
  ]
}

What’s in the bundle

Group	Used by
`statusTypes`	`statusTypeId` on schedule items and venues
`scheduleItemTypes`, `itemTypes`	`type` / `itemTypeId` on schedule items
`scheduleItemTimeTypes`	`startTimeTypeId`, `endTimeTypeId`
`scheduleItemTravelTypes`	`travelTypeId` on travel items
`reminderTypes`	`typeId` inside a reminder
`avatarColors`	`colorId` on tags, `itemColorId` on schedule items, `avatarColorId` on contacts
`dayTypes`	`day_type_id` on tour days
`guestlistStatuses`	`statusId` on guest list entries
`pickupMethods`	`pickupMethodId` on guest list entries
`passMaterialTypes`	pass configuration
`venueTypes`, `venueCategories`	`venueTypeId`, `venueCategoryId`
`hotelRoomTypes`	`roomType` on rooms
`orgTypes`, `userRoleTypes`, `userStatuses`, `operationTypes`, `featureTypes`, `enquiryTypes`, `feedbackCategories`, `supportCategories`, `accDeleteReasons`, `dataReqReasons`	Internal / informational

The table above lists the groups present today. Treat the bundle as open-ended — read the name of each entry in the response rather than assuming a fixed set or count, so a newly added lookup group doesn’t break your parsing.

Age restrictions

GET /v1/reference/age-restrictions

Scope: venues.read Not part of the bundle above — it has a different shape. Response data

[{ "id": 3, "label": "18+" }]

Age restrictions use label, not the type field every other lookup uses.

Venue field templates

GET /v1/reference/venue-field-templates

Scope: venues.read The premade venue custom fields — their key values are what you pass as templateKey. See Custom Fields. Response data

[{
  "id": 1,
  "key": "venue_type",
  "icon": "building",
  "label": "Venue type",
  "subtitle": "Bar, theatre, arena...",
  "field_type": "enum",
  "sort_order": 0
}]

A field_type of enum means the value should come from another lookup — venue_type from venueTypes, age_restriction from the age-restrictions endpoint above.

Stay field templates

GET /v1/reference/stay-field-templates

Scope: accommodation.read The premade accommodation custom fields. Response data

[{
  "id": 1,
  "key": "confirmation_number",
  "icon": "hash",
  "label": "Confirmation number",
  "subtitle": "Booking reference",
  "sort_order": 0
}]

Guest list requesters

GET /v1/tours/{tourId}/requesters

Scope: guestlist.read The tour users who can be set as a guest list entry’s requester. Tour-scoped, unlike the lookups above. Response data

[{ "id": "cdd1…", "firstname": "Jane", "lastname": "Doe", "email": "jane@…", "image": null }]

Endpoint	Returns
`GET /v1/day-types`	Day types (also in the bundle)
`GET /v1/tours/{tourId}/passTypes`	A tour’s pass types, for `passId`

See also: Field Reference for the static enum values, Custom Fields.

Get started

Endpoints

Guides

Reference

All lookup types

What’s in the bundle

Age restrictions

Venue field templates

Stay field templates

Guest list requesters

​All lookup types

​What’s in the bundle

​Age restrictions

​Venue field templates

​Stay field templates

​Guest list requesters

​Related lookups elsewhere

All lookup types

What’s in the bundle

Age restrictions

Venue field templates

Stay field templates

Guest list requesters

Related lookups elsewhere