Skip to main content

Experience Guides API

The Guides API manages staff guide assignments on individual experience availability slots.

What You Can Do​

  • List guides currently assigned to a slot
  • Picker — get a grouped view of available, partially available, and unavailable staff for a slot
  • Assign one or more guides; get back blocked/warned results per guide
  • Remove a specific guide from a slot

Guide requirements​

An experience can say what a guide should hold and speak: required_certifications and required_languages on the experience itself. Assigning a guide who is missing one returns the gap in the warned list on the assign response. It is never a block - the guide is still assigned and the departure still sells.

A higher certificate counts for a lower one. A guide with a current uscg_master meets a uscg_oupv requirement, wilderness_first_responder meets wilderness_first_aid, and lifeguard meets cpr and first_aid. An expired certificate counts for nothing.

Set them on the experience with Create Experience or Update Experience.

Base Path​

All guide endpoints are nested under /v1/experience-availability/{id}/guides, where {id} is an experience availability slot ID.

Authentication​

All endpoints require a bearer API key. Read operations require experiences:read; write operations require experiences:write.