scheduleit_list_events
List events
List scheduled events and tasks (bookings, shifts, jobs). Without date_from/date_to Schedule It uses its default date range. Schedule It returns only a short summary of each event unless you name the fields you want: pass `fields` such as id,title,date_start,date_end,owner,notes,completed,priority,custom1 (get_event returns ALL fields of one event). `owner` holds the ids of the resources (people, rooms, equipment) the event is linked to. There is no paging: the reply holds up to `limit` events (default 100), so narrow with the filters instead. Do not call this repeatedly to watch for changes (use modified_after to fetch only what changed). GET /api/events.
Parameterslimittitlefieldsdate_todate_fromevent_idstasks_onlyno_date_onlyresource_idsworkspace_idmodified_afterresource_match
scheduleit_get_event
Get event
One event or task by id with ALL its fields (title, dates, linked resources, notes, completion, priority, custom fields). GET /api/events/{id}.
Parametersevent_idrequired
scheduleit_create_event
Create event
WRITE: create a new event (booking, shift, job or task) in the Schedule It account, optionally linked to resources. It becomes visible to everyone with access to the schedule, and Schedule It may notify the linked resources according to the account's own notification settings. Confirm the title, dates and resources with the user first. POST /api/events.
Parametersnotestitlerequireddate_endprioritycompletedcolor_backcolor_textdate_startresource_idscustom_fields
scheduleit_update_event
Update event
WRITE: change fields of an existing event; only the fields you pass are changed, the rest stay as they are. Passing resource_ids replaces the whole list of linked resources; an empty string clears notes or a custom field. Changing dates or resources may notify people per the account's notification settings. POST /api/events/{id}.
Parametersnotestitledate_endevent_idrequiredprioritycompletedcolor_backcolor_textdate_startresource_idscustom_fields
scheduleit_delete_event
Delete event
WRITE, DESTRUCTIVE: permanently delete one event or task. It cannot be undone through the API. Only call this when the user clearly asked for this event to be deleted. DELETE /api/events/{id}.
Parametersconfirmrequiredevent_idrequired
scheduleit_list_resources
List resources
List resources: the people, rooms, equipment or vehicles that events are scheduled against. Schedule It returns only a short summary unless you pass `fields` (for example id,name,email,data1; get_resource returns ALL fields of one). Resources belong to groups (`owner` = group ids). There is no paging; the reply holds up to `limit` resources (default 100). GET /api/resources.
Parametersnamelimitfieldsgroup_idsresource_idsworkspace_idmodified_after
scheduleit_get_resource
Get resource
One resource by id with ALL its fields (name, email, groups, details 1-10, colours, skills). GET /api/resources/{id}.
Parametersresource_idrequired
scheduleit_create_resource
Create resource
WRITE: add a new resource (a person, room, piece of equipment) to the Schedule It account. It may count toward the account's licensed resources or users. Confirm the details with the user first. POST /api/resources.
Parametersnamerequiredemaildetailsgroup_idscolor_backcolor_textcolor_event_back
scheduleit_update_resource
Update resource
WRITE: change fields of an existing resource; only the fields you pass are changed. Passing group_ids replaces the whole list of groups; an empty string clears email or a detail field. POST /api/resources/{id}.
Parametersnameemaildetailsgroup_idscolor_backcolor_textresource_idrequiredcolor_event_back
scheduleit_list_groups
List groups
List resource groups (the categories resources are organised in, e.g. Staff, Rooms, Vehicles). Pass `fields` (e.g. id,name) for more than the short summary. GET /api/groups.
Parametersnamelimitfieldsgroup_idsworkspace_id
scheduleit_get_group
Get group
One resource group by id with ALL its fields. GET /api/groups/{id}.
Parametersgroup_idrequired
scheduleit_create_group
Create group
WRITE: add a new resource group to the Schedule It account. POST /api/groups.
Parametersnamerequiredpositioncolor_backmax_resourcesmin_resourceshide_from_mainhide_from_event
scheduleit_update_group
Update group
WRITE: change fields of an existing resource group; only the fields you pass are changed. POST /api/groups/{id}.
Parametersnamegroup_idrequiredpositioncolor_backmax_resourcesmin_resourceshide_from_mainhide_from_event
scheduleit_list_labels
List labels
List the labels that can be put on events (for example Confirmed, Urgent). Pass `fields` (e.g. id,name) for more than the short summary. GET /api/labels.
Parameterslimitfields
scheduleit_list_label_groups
List label groups
List label groups (the categories that labels are organised in). Pass `fields` (e.g. id,name) for more than the short summary. GET /api/labelgroups.
Parameterslimitfields
