Get Event Types Documentation

GET/eventTypes

Lists the organization's event types with their sections, attribute and role placements, intake form, base template and template input mappings. Archived types are left out unless includeArchived is true. The organization comes from the x-Organization-Token header. Requires organization admin. Type ids for the other event type operations come from this list.

Query Parameters

Field	Type	Required	Description
includeArchived	boolean	Optional

Response

Type: GetEventTypeResponse[]

GetEventTypeResponse

Field	Type	Description
id	uuid
name	string\| null
icon	string\| null
color	string\| null
isArchived	boolean
intakeFormId	uuid\| null
baseTemplateId	uuid\| null
requireIntakeToEnter	boolean
sections	GetEventTypeResponseSectionInfo[]\| null
templateInputMappings	GetEventTypeResponseTemplateInputMappingInfo[]\| null

GetEventTypeResponseSectionInfo

Field	Type	Description
id	uuid
name	string\| null
index	integer
attributes	GetEventTypeResponseAssignmentInfo[]\| null
roles	GetEventTypeResponseRoleAssignmentInfo[]\| null

GetEventTypeResponseTemplateInputMappingInfo

Field	Type	Description
templateInputId	uuid
sourceKind	string\| null
attributeId	uuid\| null
roleDefinitionId	uuid\| null

GetEventTypeResponseAssignmentInfo

Field	Type	Description
attributeId	uuid
name	string\| null
type	string\| null
isRequired	boolean
isTaskTracked	boolean
isTaskReviewRequired	boolean
dueDateRule	GetEventTypeResponseDueDateRuleInfo
defaultAssignee	GetEventTypeResponseDefaultAssigneeInfo
index	integer

GetEventTypeResponseRoleAssignmentInfo

Field	Type	Description
roleDefinitionId	uuid
name	string\| null
fillerKind	string\| null
cardinality	string\| null
availability	GetEventTypeResponseAvailabilityInfo
defaultIsRequired	boolean
defaultIsTaskTracked	boolean
isTaskReviewRequired	boolean
dueDateRule	GetEventTypeResponseDueDateRuleInfo
defaultAssignee	GetEventTypeResponseDefaultAssigneeInfo
index	integer