v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB

Events

Get Guest Event by ID

Get specific details for a Guest event with its event parts and invitees by guest_event_id.

Guest events allow organizations to pre-register and manage visitors for specific events. See https://help.verkada.com/guest/configuration-and-setup/guest-events for more information.

get/v2/guest/guest_events/{guest_event_id}

guest_event_idstring required

end_timestring required

The ending time of the event. This will be for the last event part of multi-part events in RFC 3339 format (e.g., '2025-01-17T21:06:20+00:00').

event_addressstring

The location of the event taking place.

event_descriptionstring

A description of the Guest event.

event_namestring

The name of the Guest event. If not specified, defaults to 'New Event'.

event_sourcestring required

The source at which the event was created from.

guest_event_idstring uuid required

The unique identifier of the Guest event.

guest_type_idstring uuid

The unique identifier of the Guest type for this event. Guest types can be retrieved with the Guest Type API.

host_idstring uuid required

The unique identifier of the host. Hosts can be retrieved with the Guest Host API.

rsvp_linkstring

The RSVP link of the event if generated.

site_idstring uuid required

The unique identifier of the Guest site. Valid sites can be retrieved with the Guest Site API.

start_timestring required

The starting time of the event. This will be for the first event part of multi-part events in RFC 3339 format (e.g., '2025-01-17T21:06:20+00:00').

statusstring required

The status of the event (active, canceled or rescheduled).

walk_in_enabledboolean required

Whether walk-ins are allowed to the event.