Rooms and equipment
Rooms and equipment in Allpage: its screens, what you can do there and its operations.
Availability. Every business has it.
What you can do
- Add or change a room or equipment: the assistant can do it on its own
- Block off a room or equipment: the assistant asks you first
- Open a blocked room or equipment: the assistant asks you first
- Set a team member’s hours and bookings: the assistant asks you first
For apps
Tools
- resources_save (Add or change a room or equipment): a private change: runs now if the owner lets your app make private changes, otherwise waits for their approval
- resources_block (Block off a room or equipment): customers see it: waits for the owner’s approval unless they chose Just do it for your app
- resources_unblock (Open a blocked room or equipment): customers see it: waits for the owner’s approval unless they chose Just do it for your app
- resources_savePerson (Set a team member’s hours and bookings): customers see it: waits for the owner’s approval unless they chose Just do it for your app
Reads
- resources_list (See your rooms and equipment)
- resources_summary (What’s going on)
Operations
Each one's input and output, as JSON Schema. Ids are typed (typed ids).
resources.block
Block off a room or equipment
- Kind
- Change
- Tool
resources_block- Scope
resources:write- Reached by
- API, MCP, ChatGPT
customers see it: waits for the owner’s approval unless they chose Just do it for your app
Input
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^res_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A resource id: res_ and 26 letters and digits."
},
"start": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"end": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"note": {
"default": "",
"description": "Why, for your calendar: \"Kiln firing\", \"Repairs\".",
"type": "string",
"maxLength": 200
}
},
"required": [
"resourceId",
"start",
"end"
],
"additionalProperties": false
}Output
{
"oneOf": [
{
"type": "object",
"required": [
"status",
"title",
"change"
],
"properties": {
"status": {
"const": "done"
},
"title": {
"type": "string"
},
"change": {
"type": "boolean"
},
"result": {},
"undo": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"input": {}
}
}
}
},
{
"type": "object",
"required": [
"status",
"proposalId"
],
"properties": {
"status": {
"const": "proposed"
},
"proposalId": {
"type": "string"
},
"preview": {},
"approveAt": {
"type": "string",
"format": "uri"
}
}
},
{
"type": "object",
"required": [
"status",
"check"
],
"properties": {
"status": {
"const": "pending"
},
"message": {
"type": "string"
},
"check": {
"type": "string"
},
"checkInput": {
"type": "object"
}
}
},
{
"type": "object",
"required": [
"status",
"message"
],
"properties": {
"status": {
"const": "refused"
},
"message": {
"type": "string"
},
"field": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"status",
"kind",
"message"
],
"properties": {
"status": {
"const": "needs"
},
"kind": {
"type": "string"
},
"message": {
"type": "string"
},
"note": {
"type": "string"
}
}
}
]
}resources.list
See your rooms and equipment
- Kind
- Read
- Tool
resources_list- Scope
resources:read- Reached by
- API, MCP, ChatGPT
Read-only.
Input
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}Output
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "done"
},
"title": {
"type": "string"
},
"change": {
"type": "boolean"
},
"result": {
"type": "object",
"properties": {
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^res_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A resource id: res_ and 26 letters and digits."
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"room",
"equipment"
]
},
"locationId": {
"type": "string",
"pattern": "^loc_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A location id: loc_ and 26 letters and digits."
},
"groupId": {
"anyOf": [
{
"type": "string",
"pattern": "^rgp_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A resource group id: rgp_ and 26 letters and digits."
},
{
"type": "null"
}
],
"description": "The group it belongs to, if any."
},
"capacity": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "How many people fit, for a room."
},
"active": {
"type": "boolean",
"description": "Whether it can be booked."
}
},
"required": [
"id",
"name",
"kind",
"locationId",
"groupId",
"capacity",
"active"
],
"additionalProperties": false
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^rgp_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A resource group id: rgp_ and 26 letters and digits."
},
"name": {
"type": "string"
},
"resourceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^res_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A resource id: res_ and 26 letters and digits."
},
"description": "Its members; a booking can take any free one."
}
},
"required": [
"id",
"name",
"resourceIds"
],
"additionalProperties": false
}
}
},
"required": [
"resources",
"groups"
],
"additionalProperties": false
}
},
"required": [
"status",
"title",
"change",
"result"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "refused"
},
"title": {
"type": "string"
},
"change": {
"type": "boolean"
},
"message": {
"type": "string"
},
"field": {
"type": "string"
}
},
"required": [
"status",
"title",
"change",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "needs"
},
"kind": {
"type": "string",
"enum": [
"module",
"portal",
"business",
"limit",
"paused",
"reauth"
]
},
"title": {
"type": "string"
},
"change": {
"type": "boolean"
},
"message": {
"type": "string"
},
"note": {
"type": "string"
}
},
"required": [
"status",
"kind",
"title",
"change",
"message"
],
"additionalProperties": {}
}
]
}resources.save
Add or change a room or equipment
- Kind
- Change
- Tool
resources_save- Scope
resources:write- Reached by
- API, MCP, ChatGPT
a private change: runs now if the owner lets your app make private changes, otherwise waits for their approval
Input
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resourceId": {
"description": "The room or equipment to change; leave out to add one.",
"type": "string",
"pattern": "^res_[0-9a-hjkmnp-tv-z]{26}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"kind": {
"description": "A room or a piece of equipment. New ones are rooms.",
"type": "string",
"enum": [
"room",
"equipment"
]
},
"locationId": {
"description": "Where it is, when the business has more than one place. New ones go at the main location.",
"type": "string",
"pattern": "^loc_[0-9a-hjkmnp-tv-z]{26}$"
},
"group": {
"description": "The group it belongs to, like \"Treatment rooms\", so a booking can take any free one. Made the first time it’s named; null takes it out of its group.",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"capacity": {
"description": "How many people fit, for a room.",
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 10000
},
{
"type": "null"
}
]
},
"active": {
"description": "Whether it can be booked. New ones can.",
"type": "boolean"
}
},
"required": [
"name"
],
"additionalProperties": false
}Output
{
"oneOf": [
{
"type": "object",
"required": [
"status",
"title",
"change"
],
"properties": {
"status": {
"const": "done"
},
"title": {
"type": "string"
},
"change": {
"type": "boolean"
},
"result": {},
"undo": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"input": {}
}
}
}
},
{
"type": "object",
"required": [
"status",
"proposalId"
],
"properties": {
"status": {
"const": "proposed"
},
"proposalId": {
"type": "string"
},
"preview": {},
"approveAt": {
"type": "string",
"format": "uri"
}
}
},
{
"type": "object",
"required": [
"status",
"check"
],
"properties": {
"status": {
"const": "pending"
},
"message": {
"type": "string"
},
"check": {
"type": "string"
},
"checkInput": {
"type": "object"
}
}
},
{
"type": "object",
"required": [
"status",
"message"
],
"properties": {
"status": {
"const": "refused"
},
"message": {
"type": "string"
},
"field": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"status",
"kind",
"message"
],
"properties": {
"status": {
"const": "needs"
},
"kind": {
"type": "string"
},
"message": {
"type": "string"
},
"note": {
"type": "string"
}
}
}
]
}resources.savePerson
Set a team member’s hours and bookings
- Kind
- Change
- Tool
resources_savePerson- Scope
resources:write- Reached by
- API, MCP, ChatGPT
customers see it: waits for the owner’s approval unless they chose Just do it for your app
Input
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^res_[0-9a-hjkmnp-tv-z]{26}$",
"description": "The team member’s calendar: their calendarId from team.members. A resource id: res_ and 26 letters and digits."
},
"bookable": {
"description": "Whether customers can book them online.",
"type": "boolean"
},
"hours": {
"description": "Their own working hours; null follows the business’s booking hours.",
"anyOf": [
{
"type": "object",
"properties": {
"weekly": {
"minItems": 7,
"maxItems": 7,
"type": "array",
"items": {
"maxItems": 4,
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 1440,
"multipleOf": 5
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 1440,
"multipleOf": 5
}
},
"required": [
"start",
"end"
],
"additionalProperties": false
}
},
"description": "Each weekday from Sunday: the windows they work, in minutes of the day (540 is 9:00 AM). An empty day is a day off."
},
"daysOff": {
"default": [],
"description": "Dates they’re off, whatever the weekday.",
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
}
},
"required": [
"weekly"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"resourceId"
],
"additionalProperties": false
}Output
{
"oneOf": [
{
"type": "object",
"required": [
"status",
"title",
"change"
],
"properties": {
"status": {
"const": "done"
},
"title": {
"type": "string"
},
"change": {
"type": "boolean"
},
"result": {},
"undo": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"input": {}
}
}
}
},
{
"type": "object",
"required": [
"status",
"proposalId"
],
"properties": {
"status": {
"const": "proposed"
},
"proposalId": {
"type": "string"
},
"preview": {},
"approveAt": {
"type": "string",
"format": "uri"
}
}
},
{
"type": "object",
"required": [
"status",
"check"
],
"properties": {
"status": {
"const": "pending"
},
"message": {
"type": "string"
},
"check": {
"type": "string"
},
"checkInput": {
"type": "object"
}
}
},
{
"type": "object",
"required": [
"status",
"message"
],
"properties": {
"status": {
"const": "refused"
},
"message": {
"type": "string"
},
"field": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"status",
"kind",
"message"
],
"properties": {
"status": {
"const": "needs"
},
"kind": {
"type": "string"
},
"message": {
"type": "string"
},
"note": {
"type": "string"
}
}
}
]
}resources.summary
What’s going on
- Kind
- Read
- Tool
resources_summary- Scope
resources:read- Reached by
- API, MCP
Read-only.
Input
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}Output
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "done"
},
"title": {
"type": "string"
},
"change": {
"type": "boolean"
},
"result": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"facts": {
"type": "array",
"items": {
"type": "string"
},
"description": "One-line facts, e.g. \"3 bookings today\"."
},
"attention": {
"description": "Things that need the owner, each with a plain reason.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"href": {
"type": "string"
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
}
},
"happening": {
"description": "What’s on today, each at its time.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"at": {
"type": "number",
"description": "Epoch milliseconds."
},
"text": {
"type": "string"
},
"href": {
"type": "string"
}
},
"required": [
"id",
"at",
"text"
],
"additionalProperties": false
}
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "number"
},
"prior": {
"type": "number"
},
"unit": {
"type": "string",
"enum": [
"count",
"money"
]
},
"href": {
"type": "string"
}
},
"required": [
"id",
"label",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"title",
"facts"
],
"additionalProperties": false
}
},
"required": [
"status",
"title",
"change",
"result"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "refused"
},
"title": {
"type": "string"
},
"change": {
"type": "boolean"
},
"message": {
"type": "string"
},
"field": {
"type": "string"
}
},
"required": [
"status",
"title",
"change",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "needs"
},
"kind": {
"type": "string",
"enum": [
"module",
"portal",
"business",
"limit",
"paused",
"reauth"
]
},
"title": {
"type": "string"
},
"change": {
"type": "boolean"
},
"message": {
"type": "string"
},
"note": {
"type": "string"
}
},
"required": [
"status",
"kind",
"title",
"change",
"message"
],
"additionalProperties": {}
}
]
}resources.unblock
Open a blocked room or equipment
- Kind
- Change
- Tool
resources_unblock- Scope
resources:write- Reached by
- API, MCP, ChatGPT
customers see it: waits for the owner’s approval unless they chose Just do it for your app
Input
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"blockId": {
"type": "string",
"pattern": "^rsv_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A reservation id: rsv_ and 26 letters and digits."
}
},
"required": [
"blockId"
],
"additionalProperties": false
}Output
{
"oneOf": [
{
"type": "object",
"required": [
"status",
"title",
"change"
],
"properties": {
"status": {
"const": "done"
},
"title": {
"type": "string"
},
"change": {
"type": "boolean"
},
"result": {},
"undo": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"input": {}
}
}
}
},
{
"type": "object",
"required": [
"status",
"proposalId"
],
"properties": {
"status": {
"const": "proposed"
},
"proposalId": {
"type": "string"
},
"preview": {},
"approveAt": {
"type": "string",
"format": "uri"
}
}
},
{
"type": "object",
"required": [
"status",
"check"
],
"properties": {
"status": {
"const": "pending"
},
"message": {
"type": "string"
},
"check": {
"type": "string"
},
"checkInput": {
"type": "object"
}
}
},
{
"type": "object",
"required": [
"status",
"message"
],
"properties": {
"status": {
"const": "refused"
},
"message": {
"type": "string"
},
"field": {
"type": "string"
}
}
},
{
"type": "object",
"required": [
"status",
"kind",
"message"
],
"properties": {
"status": {
"const": "needs"
},
"kind": {
"type": "string"
},
"message": {
"type": "string"
},
"note": {
"type": "string"
}
}
}
]
}