Docs

Get Event Type

GET /eventTypes/{typeId}

GET/eventTypes/{typeId}

Returns one event type in full, which is what the Type Editor opens: its sections, the attribute and role placements with their flags, due date rules and default assignees, and its intake form, base template and template input mappings. Find the id with EventTypes_GetEventTypes. Requires organization admin.

Path Parameters

FieldTypeRequiredDescription
typeIduuidRequired

Response

FieldTypeDescription
iduuid
namestring| null
iconstring| null
colorstring| null
isArchivedboolean
intakeFormIduuid| null
baseTemplateIduuid| null
requireIntakeToEnterboolean
sectionsGetEventTypeResponseSectionInfo[]| null
templateInputMappingsGetEventTypeResponseTemplateInputMappingInfo[]| null

GetEventTypeResponseSectionInfo

FieldTypeDescription
iduuid
namestring| null
indexinteger
attributesGetEventTypeResponseAssignmentInfo[]| null
rolesGetEventTypeResponseRoleAssignmentInfo[]| null

GetEventTypeResponseTemplateInputMappingInfo

FieldTypeDescription
templateInputIduuid
sourceKindstring| null
attributeIduuid| null
roleDefinitionIduuid| null

GetEventTypeResponseAssignmentInfo

FieldTypeDescription
attributeIduuid
namestring| null
typestring| null
isRequiredboolean
isTaskTrackedboolean
isTaskReviewRequiredboolean
dueDateRuleGetEventTypeResponseDueDateRuleInfo
defaultAssigneeGetEventTypeResponseDefaultAssigneeInfo
indexinteger

GetEventTypeResponseRoleAssignmentInfo

FieldTypeDescription
roleDefinitionIduuid
namestring| null
fillerKindstring| null
cardinalitystring| null
availabilityGetEventTypeResponseAvailabilityInfo
defaultIsRequiredboolean
defaultIsTaskTrackedboolean
isTaskReviewRequiredboolean
dueDateRuleGetEventTypeResponseDueDateRuleInfo
defaultAssigneeGetEventTypeResponseDefaultAssigneeInfo
indexinteger

GetEventTypeResponseDueDateRuleInfo

FieldTypeDescription
kindstring| null
datedate-time| null
sourceAttributeIduuid| null
offsetinteger| null
unitstring| null

GetEventTypeResponseDefaultAssigneeInfo

FieldTypeDescription
kindstring| null
orgCrewIduuid| null
roleDefinitionIduuid| null
targetTemplateCollaboratorIduuid| null
grantedPermissionsstring[]| null

GetEventTypeResponseAvailabilityInfo

FieldTypeDescription
recordIdsuuid[]| null