scheduleit_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.

Argument	Type	Description
notes	string	Notes. On update an empty string clears them.
title*	string	Event title.
date_end	string	End, yyyy-mm-dd hh:mm[:ss].
priority	integer	Priority number (Schedule It's priority scale).
completed	integer	Percent completed, 0-100.
color_back	string	Background colour, e.g. #FFFFFF.
color_text	string	Text colour, e.g. #66FF66.
date_start	string	Start, yyyy-mm-dd hh:mm[:ss].
resource_ids	array	Resources (people, rooms, equipment) the event is linked to (the `owner` field). On update this REPLACES the whole list.
custom_fields	object	Custom field values keyed custom1..custom9 (the account's custom field labels are set in Schedule It). An empty string clears a field.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "title"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "maxLength": 20000,
      "description": "Notes. On update an empty string clears them."
    },
    "title": {
      "type": "string",
      "maxLength": 250,
      "minLength": 1,
      "description": "Event title."
    },
    "date_end": {
      "type": "string",
      "description": "End, yyyy-mm-dd hh:mm[:ss]."
    },
    "priority": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "Priority number (Schedule It's priority scale)."
    },
    "completed": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "Percent completed, 0-100."
    },
    "color_back": {
      "type": "string",
      "pattern": "^#[0-9A-Fa-f]{6}$",
      "description": "Background colour, e.g. #FFFFFF."
    },
    "color_text": {
      "type": "string",
      "pattern": "^#[0-9A-Fa-f]{6}$",
      "description": "Text colour, e.g. #66FF66."
    },
    "date_start": {
      "type": "string",
      "description": "Start, yyyy-mm-dd hh:mm[:ss]."
    },
    "resource_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 200,
      "minItems": 1,
      "description": "Resources (people, rooms, equipment) the event is linked to (the `owner` field). On update this REPLACES the whole list."
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom field values keyed custom1..custom9 (the account's custom field labels are set in Schedule It). An empty string clears a field.",
      "propertyNames": {
        "enum": [
          "custom1",
          "custom2",
          "custom3",
          "custom4",
          "custom5",
          "custom6",
          "custom7",
          "custom8",
          "custom9"
        ],
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 2000
      }
    }
  }
}

scheduleit_create_group

WRITE: add a new resource group to the Schedule It account. POST /api/groups.

Argument	Type	Description
name*	string	Group name.
position	integer	Position of the group in the schedule (positionv).
color_back	string	Group colour, e.g. #66FF66.
max_resources	integer	Most resources an event can use from this group (0 = no limit).
min_resources	integer	Fewest resources an event needs from this group (0 = no minimum).
hide_from_main	boolean	Hide the group from the main schedule view.
hide_from_event	boolean	Hide the group from the event form.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 250,
      "minLength": 1,
      "description": "Group name."
    },
    "position": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 0,
      "description": "Position of the group in the schedule (positionv)."
    },
    "color_back": {
      "type": "string",
      "pattern": "^#[0-9A-Fa-f]{6}$",
      "description": "Group colour, e.g. #66FF66."
    },
    "max_resources": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 0,
      "description": "Most resources an event can use from this group (0 = no limit)."
    },
    "min_resources": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 0,
      "description": "Fewest resources an event needs from this group (0 = no minimum)."
    },
    "hide_from_main": {
      "type": "boolean",
      "description": "Hide the group from the main schedule view."
    },
    "hide_from_event": {
      "type": "boolean",
      "description": "Hide the group from the event form."
    }
  }
}

scheduleit_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.

Argument	Type	Description
name*	string	Resource name.
email	string	Email address of the resource (an empty string clears it on update).
details	object	Detail values keyed data1..data10 (for example data1 = job title; the labels are set in Schedule It). An empty string clears a field.
group_ids	array	Groups the resource belongs to (the `owner` field). On update this REPLACES the whole list.
color_back	string	Resource background colour, e.g. #A9F5A9.
color_text	string	Resource text colour.
color_event_back	string	Background colour of this resource's events.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 250,
      "minLength": 1,
      "description": "Resource name."
    },
    "email": {
      "type": "string",
      "maxLength": 250,
      "description": "Email address of the resource (an empty string clears it on update)."
    },
    "details": {
      "type": "object",
      "description": "Detail values keyed data1..data10 (for example data1 = job title; the labels are set in Schedule It). An empty string clears a field.",
      "propertyNames": {
        "enum": [
          "data1",
          "data2",
          "data3",
          "data4",
          "data5",
          "data6",
          "data7",
          "data8",
          "data9",
          "data10"
        ],
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 2000
      }
    },
    "group_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 200,
      "minItems": 1,
      "description": "Groups the resource belongs to (the `owner` field). On update this REPLACES the whole list."
    },
    "color_back": {
      "type": "string",
      "pattern": "^#[0-9A-Fa-f]{6}$",
      "description": "Resource background colour, e.g. #A9F5A9."
    },
    "color_text": {
      "type": "string",
      "pattern": "^#[0-9A-Fa-f]{6}$",
      "description": "Resource text colour."
    },
    "color_event_back": {
      "type": "string",
      "pattern": "^#[0-9A-Fa-f]{6}$",
      "description": "Background colour of this resource's events."
    }
  }
}

scheduleit_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}.

destructive

Argument	Type	Description
confirm*	boolean	Must be true: the user confirmed this event should be permanently deleted.
event_id*	integer	Schedule It event id to delete.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "event_id",
    "confirm"
  ],
  "properties": {
    "confirm": {
      "type": "boolean",
      "const": true,
      "description": "Must be true: the user confirmed this event should be permanently deleted."
    },
    "event_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Schedule It event id to delete.",
      "exclusiveMinimum": 0
    }
  }
}

scheduleit_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}.

read-only

Argument	Type	Description
event_id*	integer	Schedule It event id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "event_id"
  ],
  "properties": {
    "event_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Schedule It event id.",
      "exclusiveMinimum": 0
    }
  }
}

scheduleit_get_group

One resource group by id with ALL its fields. GET /api/groups/{id}.

read-only

Argument	Type	Description
group_id*	integer	Schedule It group id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "group_id"
  ],
  "properties": {
    "group_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Schedule It group id.",
      "exclusiveMinimum": 0
    }
  }
}

scheduleit_get_resource

One resource by id with ALL its fields (name, email, groups, details 1-10, colours, skills). GET /api/resources/{id}.

read-only

Argument	Type	Description
resource_id*	integer	Schedule It resource id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "resource_id"
  ],
  "properties": {
    "resource_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Schedule It resource id.",
      "exclusiveMinimum": 0
    }
  }
}

scheduleit_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.

read-only

Argument	Type	Description
limit	integer	Most events to return, 1-1000 (default 100).
title	string	Events whose title contains this text.
fields	string	Comma-separated fields to return, e.g. id,title,date_start,date_end,owner.
date_to	string	Events up to this date (date_range_to).
date_from	string	Events from this date (date_range_from).
event_ids	array	Only these event ids.
tasks_only	boolean	true = only tasks, false = only events that are not tasks.

scheduleit_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.

read-only

Argument	Type	Description
name	string	Groups whose name contains this text.
limit	integer	Most groups to return, 1-1000 (default 100).
fields	string	Comma-separated fields to return, e.g. id,name.
group_ids	array	Only these group ids.
workspace_id	integer	Workspace id (Account Settings > Workspaces). Omit for the main workspace (id 1).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 250,
      "minLength": 1,
      "description": "Groups whose name contains this text."
    },
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Most groups to return, 1-1000 (default 100)."
    },
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_]+(,[A-Za-z0-9_]+)*$",
      "maxLength": 500,
      "description": "Comma-separated fields to return, e.g. id,name."
    },
    "group_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 200,
      "minItems": 1,
      "description": "Only these group ids."
    },
    "workspace_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Workspace id (Account Settings > Workspaces). Omit for the main workspace (id 1).",
      "exclusiveMinimum": 0
    }
  }
}

scheduleit_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.

read-only

Argument	Type	Description
limit	integer	Most label groups to return, 1-1000 (default 100).
fields	string	Comma-separated fields to return, e.g. id,name.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Most label groups to return, 1-1000 (default 100)."
    },
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_]+(,[A-Za-z0-9_]+)*$",
      "maxLength": 500,
      "description": "Comma-separated fields to return, e.g. id,name."
    }
  }
}

scheduleit_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.

read-only

Argument	Type	Description
limit	integer	Most labels to return, 1-1000 (default 100).
fields	string	Comma-separated fields to return, e.g. id,name.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Most labels to return, 1-1000 (default 100)."
    },
    "fields": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_]+(,[A-Za-z0-9_]+)*$",
      "maxLength": 500,
      "description": "Comma-separated fields to return, e.g. id,name."
    }
  }
}

scheduleit_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.

read-only

Argument	Type	Description
name	string	Resources whose name contains this text.
limit	integer	Most resources to return, 1-1000 (default 100).
fields	string	Comma-separated fields to return, e.g. id,name,email.
group_ids	array	Only resources in these groups.
resource_ids	array	Only these resource ids.
workspace_id	integer	Workspace id (Account Settings > Workspaces). Omit for the main workspace (id 1).
modified_after	string	Only resources added or changed after this date (yyyy-mm-dd) or date and time (yyyy-mm-dd hh:mm).

Input schema (JSON)

scheduleit_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}.

destructive

Argument	Type	Description
notes	string	Notes. On update an empty string clears them.
title	string	Event title.
date_end	string	End, yyyy-mm-dd hh:mm[:ss].
event_id*	integer	Schedule It event id.
priority	integer	Priority number (Schedule It's priority scale).
completed	integer	Percent completed, 0-100.
color_back	string	Background colour, e.g. #FFFFFF.
color_text	string	Text colour, e.g. #66FF66.
date_start

scheduleit_update_group

WRITE: change fields of an existing resource group; only the fields you pass are changed. POST /api/groups/{id}.

destructive

Argument	Type	Description
name	string	Group name.
group_id*	integer	Schedule It group id.
position	integer	Position of the group in the schedule (positionv).
color_back	string	Group colour, e.g. #66FF66.
max_resources	integer	Most resources an event can use from this group (0 = no limit).
min_resources	integer	Fewest resources an event needs from this group (0 = no minimum).
hide_from_main	boolean	Hide the group from the main schedule view.
hide_from_event	boolean	Hide the group from the event form.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "group_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 250,
      "minLength": 1,
      "description": "Group name."
    },
    "group_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Schedule It group id.",
      "exclusiveMinimum": 0
    },
    "position": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 0,
      "description": "Position of the group in the schedule (positionv)."
    },
    "color_back": {
      "type": "string",
      "pattern": "^#[0-9A-Fa-f]{6}$",
      "description": "Group colour, e.g. #66FF66."
    },
    "max_resources": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 0,
      "description": "Most resources an event can use from this group (0 = no limit)."
    },
    "min_resources": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 0,
      "description": "Fewest resources an event needs from this group (0 = no minimum)."
    },
    "hide_from_main": {
      "type": "boolean",
      "description": "Hide the group from the main schedule view."
    },
    "hide_from_event": {
      "type": "boolean",
      "description": "Hide the group from the event form."
    }
  }
}

scheduleit_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}.

destructive

Argument	Type	Description
name	string	Resource name.
email	string	Email address of the resource (an empty string clears it on update).
details	object	Detail values keyed data1..data10 (for example data1 = job title; the labels are set in Schedule It). An empty string clears a field.
group_ids	array	Groups the resource belongs to (the `owner` field). On update this REPLACES the whole list.
color_back	string	Resource background colour, e.g. #A9F5A9.
color_text	string	Resource text colour.
resource_id*	integer	Schedule It resource id.
color_event_back	string	Background colour of this resource's events.

Schedule it MCP by usefulapi

Try it

scheduleit_create_event

Schedule it MCP by usefulapi

Try it

scheduleit_create_event

Tools (15)