Docs

Get Schedule Block Types

GET /schedule-block-types

GET/schedule-block-types

Returns the event's schedule block types, archived ones included and flagged by isArchived, with name, label, icon, color and an optional default resource state. A block type categorises timed work on a need or reservation (for example Work, Meal or Day off), and its default resource state sets the rate a block of that type is costed at; a type with no default state gives its blocks no base rate. Schedule blocks, rules and rate card reset definitions refer to these ids.

Response

Type: GetScheduleBlockTypeResponse[]

GetScheduleBlockTypeResponse

FieldTypeDescription
iduuid
namestring| null
labelstring| null
iconstring| null
colorstring| null
defaultResourceStateIduuid| null
isArchivedboolean