API reference
Authenticate with a personal access token or OAuth bearer token. Send a User-Agent identifying your application. Follow Link headers for pagination; respect Retry-After on rate limits.
- Base URL
https://api.sawadoo.com- OAuth discovery
https://api.sawadoo.com/.well-known/oauth-authorization-server- Basecamp-compatible CLI
BASECAMP_BASE_URL=https://api.sawadoo.com BASECAMP_LAUNCHPAD_URL=https://api.sawadoo.com
Set both variables, then add BASECAMP_ACCOUNT_ID and BASECAMP_TOKEN (a personal access token) to use the CLI against this API.
Download OpenAPI 3.1 specification
GET /up — Liveness probe
Parameters
[]
Responses
{
"200": {
"description": "The service is up",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Health"
}
}
}
}
}GET /billing/plans.json — Plans on sale
Parameters
[]
Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicPlans"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /inbound/ses — Amazon SNS endpoint for SES inbound mail (Email Forwards, reply-by-email)
Parameters
[]
Responses
{
"200": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundAck"
}
}
}
},
"400": {
"description": "Not a valid SNS message",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundError"
}
}
}
},
"403": {
"description": "Bad signature or unknown topic",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundError"
}
}
}
},
"503": {
"description": "Inbound mail is not configured",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundError"
}
}
}
}
}GET /{accountId}/account.json — Get the account
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Account"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/people.json — Get all people
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/circles/people.json — Get pingable people
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/people/{personId} — Get a person
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "personId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/my/profile.json — Get my personal info
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/my/profile.json — Update my personal info
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileUpdate"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/projects/recordings.json — Get recordings of a type
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "bucket",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "direction",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recording"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/projects.json — Get projects
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Project"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/projects.json — Create a project
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Project"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/projects/{projectId} — Get a project
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "projectId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Project"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/projects/{projectId} — Update a project
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "projectId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Project"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/projects/{projectId} — Trash a project
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "projectId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/projects/{projectId}/status/archived.json — Archive a project
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "projectId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/projects/{projectId}/status/active.json — Unarchive (or restore) a project
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "projectId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/projects/{projectId}/people.json — Get people on a project
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "projectId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/projects/{projectId}/people/users.json — Grant or revoke project access
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "projectId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectAccessInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectAccessResult"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/dock/tools.json — Add a tool to the dock
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToolCreate"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tool"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/dock/tools/{toolId} — Get a tool
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tool"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/dock/tools/{toolId} — Rename a tool
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToolUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tool"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/dock/tools/{toolId} — Trash a tool
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/dock/tools/{toolId} — Get a tool (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tool"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/dock/tools/{toolId} — Rename a tool (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToolUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tool"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/dock/tools/{toolId} — Trash a tool (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/recordings/{toolId}/position.json — Enable a tool
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tool"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/recordings/{toolId}/position.json — Disable a tool
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/recordings/{toolId}/position.json — Move a tool in the dock
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PositionInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tool"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/recordings/{toolId}/position.json — Enable a tool (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tool"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/recordings/{toolId}/position.json — Disable a tool (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/recordings/{toolId}/position.json — Move a tool in the dock (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "toolId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PositionInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tool"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/searches/metadata.json — Get search filter options
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchMetadata"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/search.json — Search
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type_names[]",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "bucket_ids[]",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "bucket_id",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "creator_ids[]",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "creator_id",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "since",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "exclude_chat",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recording"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/my/readings.json — Get my notifications
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Readings"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/my/unreads.json — Mark notifications as read
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkAsReadInput"
}
}
}
}Responses
{
"200": {
"description": "OK"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/my/assignments.json — Get my assignments
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MyAssignments"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/my/assignments/completed.json — Get my completed assignments
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MyAssignment"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/my/assignments/due.json — Get my assignments by due date
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "scope",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MyAssignment"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/my/bookmarks.json — Get my bookmarks
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bookmark"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/boosts/{boostId} — Get a boost
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boostId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Boost"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/boosts/{boostId} — Delete a boost
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boostId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/boosts/{boostId} — Get a boost (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boostId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Boost"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/boosts/{boostId} — Delete a boost (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boostId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/recordings/{recordingId} — Get a recording
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Recording"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/recordings/{recordingId} — Get a recording (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Recording"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/recordings/{recordingId}/status/trashed.json — Trash a recording
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/recordings/{recordingId}/status/trashed.json — Trash a recording (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/recordings/{recordingId}/status/archived.json — Archive a recording
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/recordings/{recordingId}/status/archived.json — Archive a recording (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/recordings/{recordingId}/status/active.json — Unarchive (or restore) a recording
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/recordings/{recordingId}/status/active.json — Unarchive (or restore) a recording (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/recordings/{recordingId}/client_visibility.json — Show or hide a recording from clients
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientVisibilityInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Recording"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/recordings/{recordingId}/client_visibility.json — Show or hide a recording from clients (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientVisibilityInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Recording"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/recordings/{recordingId}/events.json — Get events of a recording
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Event"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/recordings/{recordingId}/events.json — Get events of a recording (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Event"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/recordings/{recordingId}/boosts.json — Get boosts on a recording
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Boost"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/recordings/{recordingId}/boosts.json — Boost a recording
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BoostInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Boost"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/recordings/{recordingId}/boosts.json — Get boosts on a recording (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Boost"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/recordings/{recordingId}/boosts.json — Boost a recording (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BoostInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Boost"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/recordings/{recordingId}/subscription.json — Get who's notified
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/recordings/{recordingId}/subscription.json — Subscribe me
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/recordings/{recordingId}/subscription.json — Unsubscribe me
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/recordings/{recordingId}/subscription.json — Add or remove subscribers
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/recordings/{recordingId}/subscription.json — Get who's notified (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/recordings/{recordingId}/subscription.json — Subscribe me (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/recordings/{recordingId}/subscription.json — Unsubscribe me (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/recordings/{recordingId}/subscription.json — Add or remove subscribers (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/recordings/{recordingId}/bookmark.json — Is it bookmarked?
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookmarkStatus"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/recordings/{recordingId}/bookmark.json — Bookmark a recording
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookmarkStatus"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/recordings/{recordingId}/bookmark.json — Remove a bookmark
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/recordings/{messageId}/pin.json — Pin a message
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/recordings/{messageId}/pin.json — Unpin a message
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/recordings/{messageId}/pin.json — Pin a message (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/recordings/{messageId}/pin.json — Unpin a message (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/todosets/{todosetId} — Get a to-do set
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todosetId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todoset"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/todosets/{todosetId} — Get a to-do set (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todosetId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todoset"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/todosets/{todosetId}/todolists.json — Get to-do lists
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todosetId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Todolist"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/todosets/{todosetId}/todolists.json — Create a to-do list
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todosetId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodolistInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todolist"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/todosets/{todosetId}/todolists.json — Get to-do lists (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todosetId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Todolist"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/todosets/{todosetId}/todolists.json — Create a to-do list (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todosetId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodolistInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todolist"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/todosets/todolists/{todolistId}/position.json — Move a to-do list
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todolistId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Position"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/todosets/todolists/{todolistId}/position.json — Move a to-do list (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todolistId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Position"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/todolists/groups/{groupId}/position.json — Move a to-do list group
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "groupId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Position"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todolist"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/todolists/groups/{groupId}/position.json — Move a to-do list group (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "groupId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Position"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todolist"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/todolists/{todolistId}/groups.json — Get to-do list groups
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todolistId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Todolist"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/todolists/{todolistId}/groups.json — Create a to-do list group
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todolistId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodolistGroupInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todolist"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/todolists/{todolistId}/groups.json — Get to-do list groups (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todolistId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Todolist"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/todolists/{todolistId}/groups.json — Create a to-do list group (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todolistId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodolistGroupInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todolist"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/todolists/{todolistId}/todos.json — Get to-dos
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todolistId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "completed",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Todo"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/todolists/{todolistId}/todos.json — Create a to-do
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todolistId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodoInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todo"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/todolists/{todolistId}/todos.json — Get to-dos (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todolistId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "completed",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Todo"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/todolists/{todolistId}/todos.json — Create a to-do (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todolistId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodoInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todo"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/todolists/{id} — Get a to-do list or group
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todolist"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/todolists/{id} — Update a to-do list or group
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodolistUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todolist"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/todolists/{id} — Get a to-do list or group (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todolist"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/todolists/{id} — Update a to-do list or group (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodolistUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todolist"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/todos/{todoId} — Get a to-do
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todoId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todo"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/todos/{todoId} — Update a to-do
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todoId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodoInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todo"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/todos/{todoId} — Get a to-do (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todoId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todo"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/todos/{todoId} — Update a to-do (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todoId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodoInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todo"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/todos/{todoId}/completion.json — Complete a to-do
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todoId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/todos/{todoId}/completion.json — Uncomplete a to-do
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todoId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/todos/{todoId}/completion.json — Complete a to-do (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todoId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/todos/{todoId}/completion.json — Uncomplete a to-do (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todoId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/todos/{todoId}/position.json — Move a to-do
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todoId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodoPosition"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todo"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/todos/{todoId}/position.json — Move a to-do (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "todoId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodoPosition"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Todo"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/recordings/{recordingId}/subtasks.json — Get subtasks
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardStep"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/recordings/{recordingId}/subtasks.json — Create a subtask
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubtaskInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/recordings/{recordingId}/subtasks.json — Get subtasks (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardStep"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/recordings/{recordingId}/subtasks.json — Create a subtask (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recordingId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubtaskInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/subtasks/{subtaskId} — Get a subtask
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/subtasks/{subtaskId} — Update a subtask
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubtaskUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/subtasks/{subtaskId} — Delete a subtask
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/subtasks/{subtaskId} — Get a subtask (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/subtasks/{subtaskId} — Update a subtask (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubtaskUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/subtasks/{subtaskId} — Delete a subtask (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/subtasks/{subtaskId}/completion.json — Complete a subtask
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/subtasks/{subtaskId}/completion.json — Uncomplete a subtask
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/subtasks/{subtaskId}/completion.json — Complete a subtask (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/subtasks/{subtaskId}/completion.json — Uncomplete a subtask (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/subtasks/{subtaskId}/position.json — Move a subtask
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Position"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/subtasks/{subtaskId}/position.json — Move a subtask (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subtaskId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Position"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/message_boards/{boardId} — Get a message board
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageBoard"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/message_boards/{boardId} — Get a message board (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageBoard"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/message_boards/{boardId}/messages.json — Get messages
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/message_boards/{boardId}/messages.json — Create a message
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/message_boards/{boardId}/messages.json — Get messages (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/message_boards/{boardId}/messages.json — Create a message (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/messages/{messageId} — Get a message
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/messages/{messageId} — Update a message
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/messages/{messageId} — Get a message (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/messages/{messageId} — Update a message (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/categories.json — Get message types
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageType"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/categories.json — Create a message type
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageTypeInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageType"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/categories/{typeId} — Get a message type
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "typeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageType"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/categories/{typeId} — Update a message type
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "typeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageTypeUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageType"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/categories/{typeId} — Delete a message type
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "typeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/attachments.json — Upload a file
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentCreated"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/vaults/{vaultId} — Get a vault
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Vault"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/vaults/{vaultId} — Rename a vault
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VaultInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Vault"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/vaults/{vaultId} — Get a vault (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Vault"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/vaults/{vaultId} — Rename a vault (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VaultInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Vault"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/vaults/{vaultId}/vaults.json — Get vaults in a vault
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Vault"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/vaults/{vaultId}/vaults.json — Create a vault
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VaultInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Vault"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/vaults/{vaultId}/vaults.json — Get vaults in a vault (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Vault"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/vaults/{vaultId}/vaults.json — Create a vault (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VaultInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Vault"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/vaults/{vaultId}/documents.json — Get documents in a vault
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/vaults/{vaultId}/documents.json — Create a document
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/vaults/{vaultId}/documents.json — Get documents in a vault (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/vaults/{vaultId}/documents.json — Create a document (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/vaults/{vaultId}/uploads.json — Get uploads in a vault
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Upload"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/vaults/{vaultId}/uploads.json — Create an upload
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/vaults/{vaultId}/uploads.json — Get uploads in a vault (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Upload"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/vaults/{vaultId}/uploads.json — Create an upload (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/documents/{documentId} — Get a document
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/documents/{documentId} — Update a document
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/documents/{documentId} — Get a document (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/documents/{documentId} — Update a document (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/uploads/{uploadId} — Get an upload
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "uploadId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/uploads/{uploadId} — Update an upload
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "uploadId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/uploads/{uploadId} — Get an upload (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "uploadId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/uploads/{uploadId} — Update an upload (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "uploadId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/cloud_files/{cloudFileId} — Get a cloud file
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cloudFileId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudFile"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/cloud_files/{cloudFileId} — Get a cloud file (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cloudFileId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudFile"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/vaults/{vaultId}/cloud_files.json — Link a cloud file
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vaultId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudFileInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudFile"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/schedules/{scheduleId} — Get a schedule
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "scheduleId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Schedule"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/schedules/{scheduleId} — Update a schedule's settings
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "scheduleId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleSettingsInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Schedule"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/schedules/{scheduleId} — Get a schedule (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "scheduleId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Schedule"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/schedules/{scheduleId} — Update a schedule's settings (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "scheduleId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleSettingsInput"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Schedule"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/schedules/{scheduleId}/entries.json — Get schedule entries
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "scheduleId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleEntry"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/schedules/{scheduleId}/entries.json — Create a schedule entry
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "scheduleId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleEntryInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleEntry"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/schedules/{scheduleId}/entries.json — Get schedule entries (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "scheduleId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleEntry"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/schedules/{scheduleId}/entries.json — Create a schedule entry (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "scheduleId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleEntryInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleEntry"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/schedule_entries/{entryId} — Get a schedule entry
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "entryId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleEntry"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/schedule_entries/{entryId} — Update a schedule entry
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "entryId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleEntryUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleEntry"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/schedule_entries/{entryId} — Get a schedule entry (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "entryId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleEntry"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/schedule_entries/{entryId} — Update a schedule entry (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "entryId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleEntryUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleEntry"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/card_tables/columns/{columnId} — Get a column
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumn"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/card_tables/columns/{columnId} — Update a column
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumnUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumn"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/card_tables/columns/{columnId} — Get a column (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumn"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/card_tables/columns/{columnId} — Update a column (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumnUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumn"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/card_tables/columns/{columnId}/color.json — Change a column's colour
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumnColor"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumn"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/card_tables/columns/{columnId}/on_hold.json — Add an On hold section
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumn"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/card_tables/columns/{columnId}/on_hold.json — Remove the On hold section
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumn"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/card_tables/lists/{columnId}/cards.json — Get cards in a column
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Card"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/card_tables/lists/{columnId}/cards.json — Create a card
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Card"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/card_tables/lists/{columnId}/cards.json — Get cards in a column (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Card"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/card_tables/lists/{columnId}/cards.json — Create a card (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Card"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/card_tables/lists/{columnId}/subscription.json — Watch a column
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/card_tables/lists/{columnId}/subscription.json — Stop watching a column
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/card_tables/lists/{columnId}/subscription.json — Watch a column (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/card_tables/lists/{columnId}/subscription.json — Stop watching a column (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "columnId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/card_tables/cards/{cardId} — Get a card
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Card"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/card_tables/cards/{cardId} — Update a card
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Card"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/card_tables/cards/{cardId} — Get a card (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Card"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/card_tables/cards/{cardId} — Update a card (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Card"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/card_tables/cards/{cardId}/moves.json — Move a card
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardMove"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/card_tables/cards/{cardId}/moves.json — Move a card (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardMove"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/card_tables/cards/{cardId}/steps.json — Create a step
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStepInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/card_tables/cards/{cardId}/steps.json — Create a step (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStepInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/card_tables/cards/{cardId}/positions.json — Move a step
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStepPosition"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/card_tables/cards/{cardId}/positions.json — Move a step (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStepPosition"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/card_tables/steps/{stepId} — Get a step
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "stepId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/card_tables/steps/{stepId} — Update a step
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "stepId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStepUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/card_tables/steps/{stepId} — Get a step (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "stepId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/card_tables/steps/{stepId} — Update a step (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "stepId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStepUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/card_tables/steps/{stepId}/completions.json — Complete or reopen a step
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "stepId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStepCompletion"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/card_tables/steps/{stepId}/completions.json — Complete or reopen a step (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "stepId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStepCompletion"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardStep"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/card_tables/{cardTableId} — Get a card table
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardTableId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardTable"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/card_tables/{cardTableId} — Get a card table (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardTableId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardTable"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/card_tables/{cardTableId}/columns.json — Create a column
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardTableId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumnInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumn"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/card_tables/{cardTableId}/columns.json — Create a column (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardTableId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumnInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumn"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/card_tables/{cardTableId}/moves.json — Move a column
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardTableId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumnMove"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/card_tables/{cardTableId}/moves.json — Move a column (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "cardTableId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardColumnMove"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/chats.json — Get all chats
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Campfire"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/circles.json — Start (or reopen) a ping
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PingInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Campfire"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/chats/{campfireId} — Get a chat
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Campfire"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/chats/{campfireId} — Get a chat (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Campfire"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/chats/{campfireId}/lines.json — Get chat lines
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CampfireLine"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/chats/{campfireId}/lines.json — Post a chat line
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampfireLineInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampfireLine"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/chats/{campfireId}/lines.json — Get chat lines (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CampfireLine"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/chats/{campfireId}/lines.json — Post a chat line (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampfireLineInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampfireLine"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/chats/{campfireId}/lines/{lineId} — Get a chat line
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "lineId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampfireLine"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/chats/{campfireId}/lines/{lineId} — Edit a chat line
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "lineId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampfireLineInput"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/chats/{campfireId}/lines/{lineId} — Delete a chat line
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "lineId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/chats/{campfireId}/lines/{lineId} — Get a chat line (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "lineId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampfireLine"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/chats/{campfireId}/lines/{lineId} — Edit a chat line (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "lineId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampfireLineInput"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/chats/{campfireId}/lines/{lineId} — Delete a chat line (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "lineId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/chats/{campfireId}/uploads.json — Get files posted in a chat
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CampfireLine"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/chats/{campfireId}/uploads.json — Post a file to a chat
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampfireLine"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/chats/{campfireId}/uploads.json — Get files posted in a chat (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CampfireLine"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/chats/{campfireId}/uploads.json — Post a file to a chat (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "campfireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampfireLine"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/inboxes/{inboxId} — Get an inbox
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "inboxId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Inbox"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/inboxes/{inboxId} — Get an inbox (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "inboxId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Inbox"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/inboxes/{inboxId}/inbox_forwards.json — Get forwarded emails
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "inboxId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Forward"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/inboxes/{inboxId}/inbox_forwards.json — Get forwarded emails (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "inboxId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Forward"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/inbox_forwards/{forwardId} — Get a forwarded email
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "forwardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forward"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/inbox_forwards/{forwardId} — Get a forwarded email (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "forwardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forward"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/inbox_forwards/{forwardId}/replies.json — Get replies to a forwarded email
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "forwardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForwardReply"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/inbox_forwards/{forwardId}/replies.json — Reply to a forwarded email
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "forwardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardReplyInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardReply"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/inbox_forwards/{forwardId}/replies.json — Get replies to a forwarded email (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "forwardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForwardReply"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/inbox_forwards/{forwardId}/replies.json — Reply to a forwarded email (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "forwardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardReplyInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardReply"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/inbox_forwards/{forwardId}/replies/{replyId} — Get a reply to a forwarded email
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "forwardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "replyId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardReply"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/inbox_forwards/{forwardId}/replies/{replyId} — Get a reply to a forwarded email (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "forwardId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "replyId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForwardReply"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/questionnaires/{questionnaireId} — Get a questionnaire
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionnaireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Questionnaire"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/questionnaires/{questionnaireId} — Get a questionnaire (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionnaireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Questionnaire"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/questionnaires/{questionnaireId}/questions.json — Get questions
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionnaireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Question"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/questionnaires/{questionnaireId}/questions.json — Create a question
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionnaireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Question"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/questionnaires/{questionnaireId}/questions.json — Get questions (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionnaireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Question"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/questionnaires/{questionnaireId}/questions.json — Create a question (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionnaireId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Question"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/questions/{questionId} — Get a question
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Question"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/questions/{questionId} — Update a question
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Question"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/questions/{questionId} — Get a question (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Question"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/questions/{questionId} — Update a question (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Question"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/questions/{questionId}/pause.json — Pause a question
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Question"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/questions/{questionId}/pause.json — Resume a question
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Question"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/questions/{questionId}/pause.json — Pause a question (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Question"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/questions/{questionId}/pause.json — Resume a question (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Question"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/questions/{questionId}/answers.json — Get answers
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionAnswer"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/questions/{questionId}/answers.json — Answer a question
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionAnswerInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionAnswer"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/questions/{questionId}/answers.json — Get answers (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionAnswer"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/questions/{questionId}/answers.json — Answer a question (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionAnswerInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionAnswer"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/question_answers/{answerId} — Get an answer
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "answerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionAnswer"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/question_answers/{answerId} — Update an answer
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "answerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionAnswerUpdate"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/question_answers/{answerId} — Get an answer (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "answerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionAnswer"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/question_answers/{answerId} — Update an answer (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "answerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionAnswerUpdate"
}
}
}
}Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/webhooks.json — Get a project's webhooks
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}POST /{accountId}/buckets/{bucketId}/webhooks.json — Create a webhook
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookInput"
}
}
}
}Responses
{
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/webhooks/{webhookId} — Get a webhook
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/webhooks/{webhookId} — Update a webhook
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/webhooks/{webhookId} — Delete a webhook
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/buckets/{bucketId}/webhooks/{webhookId} — Get a webhook (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}PUT /{accountId}/buckets/{bucketId}/webhooks/{webhookId} — Update a webhook (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Request body
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookUpdate"
}
}
}
}Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}DELETE /{accountId}/buckets/{bucketId}/webhooks/{webhookId} — Delete a webhook (legacy bucket route)
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "bucketId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
]Responses
{
"204": {
"description": "No content"
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}GET /{accountId}/search/hybrid.json — Search recordings using keywords and embeddings
Parameters
[
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "q",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "project_id",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]Responses
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recording"
}
}
}
}
},
"401": {
"description": "Missing or invalid token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found, or not visible to this person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limited (see Retry-After)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Schemas
{
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "An OAuth 2.0 access token (`/oauth/tokens`, scopes `read` | `full`) or a personal access token (My Stuff → API tokens)."
}
},
"schemas": {
"Health": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"service": {
"type": "string"
}
},
"required": [
"ok",
"service"
]
},
"PublicPlans": {
"type": "object",
"properties": {
"trial_days": {
"type": "integer",
"description": "Length of the free trial for new accounts"
},
"plans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicPlan"
},
"description": "Active plans; may be empty when none is on sale"
}
},
"required": [
"trial_days",
"plans"
]
},
"PublicPlan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"amount": {
"type": "integer",
"description": "Monthly price in minor units of `currency` (4900 = $49.00)"
},
"currency": {
"type": "string",
"description": "ISO 4217 code, lowercase"
},
"projects": {
"type": "integer"
},
"storageBytes": {
"type": "integer"
},
"agentActions": {
"type": "integer"
},
"assistantMessages": {
"type": "integer"
},
"apiRate": {
"type": "integer"
},
"clientAccess": {
"type": "boolean"
},
"retentionControls": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"amount",
"currency",
"projects",
"storageBytes",
"agentActions",
"assistantMessages",
"apiRate",
"clientAccess",
"retentionControls"
]
},
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error"
]
},
"InboundAck": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
]
},
"InboundError": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
},
"required": [
"error"
]
},
"Account": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name",
"created_at",
"updated_at"
],
"additionalProperties": {}
},
"Person": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email_address": {
"type": [
"string",
"null"
]
},
"personable_type": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"admin": {
"type": "boolean"
},
"owner": {
"type": "boolean"
},
"client": {
"type": "boolean"
},
"employee": {
"type": "boolean"
},
"time_zone": {
"type": "string"
},
"avatar_url": {
"type": "string"
}
},
"required": [
"id",
"name",
"personable_type",
"admin",
"owner",
"client",
"employee",
"time_zone",
"avatar_url"
],
"additionalProperties": {}
},
"ProfileUpdate": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"title": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"bio": {
"type": [
"string",
"null"
],
"maxLength": 500
},
"location": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"time_zone_name": {
"type": "string",
"maxLength": 64
}
}
},
"Recording": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator"
],
"additionalProperties": {}
},
"Project": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"purpose": {
"type": "string"
},
"clients_enabled": {
"type": "boolean"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"dock": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DockItem"
}
}
},
"required": [
"id",
"status",
"created_at",
"updated_at",
"name",
"description",
"purpose",
"clients_enabled",
"url",
"app_url"
],
"additionalProperties": {}
},
"DockItem": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"position": {
"type": [
"number",
"null"
]
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"name",
"enabled",
"position",
"url",
"app_url"
],
"additionalProperties": {}
},
"ProjectInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 2000
},
"admissions": {
"type": "string",
"enum": [
"invite",
"employee",
"team"
]
},
"schedule_attributes": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"end_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
}
}
},
"required": [
"name"
]
},
"ProjectAccessResult": {
"type": "object",
"properties": {
"granted": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
},
"revoked": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
}
},
"required": [
"granted",
"revoked"
],
"additionalProperties": {}
},
"ProjectAccessInput": {
"type": "object",
"properties": {
"grant": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
},
"revoke": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
}
}
},
"Tool": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"id",
"title",
"name",
"enabled"
],
"additionalProperties": {}
},
"ToolCreate": {
"type": "object",
"properties": {
"tool_type": {
"type": "string"
},
"title": {
"type": "string",
"maxLength": 100
}
},
"required": [
"tool_type"
]
},
"ToolUpdate": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"title"
]
},
"PositionInput": {
"type": "object",
"properties": {
"position": {
"type": "integer",
"minimum": 1
}
},
"required": [
"position"
]
},
"SearchMetadata": {
"type": "object",
"properties": {
"recording_search_types": {
"type": "array",
"items": {}
}
},
"required": [
"recording_search_types"
],
"additionalProperties": {}
},
"Readings": {
"type": "object",
"properties": {
"unreads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
},
"reads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
},
"required": [
"unreads",
"reads"
],
"additionalProperties": {}
},
"Notification": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"section": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"created_at",
"updated_at",
"section",
"title"
],
"additionalProperties": {}
},
"MarkAsReadInput": {
"type": "object",
"properties": {
"readables": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 500
}
},
"required": [
"readables"
]
},
"MyAssignments": {
"type": "object",
"properties": {
"priorities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MyAssignment"
}
},
"non_priorities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MyAssignment"
}
}
},
"required": [
"priorities",
"non_priorities"
],
"additionalProperties": {}
},
"MyAssignment": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"content": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"content",
"type"
],
"additionalProperties": {}
},
"Bookmark": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"created_at": {
"type": "string"
},
"recording": {
"$ref": "#/components/schemas/Recording"
}
},
"required": [
"id",
"created_at",
"recording"
],
"additionalProperties": {}
},
"Boost": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"content": {
"type": "string"
},
"created_at": {
"type": "string"
},
"booster": {
"$ref": "#/components/schemas/Person"
}
},
"required": [
"id",
"content",
"created_at",
"booster"
],
"additionalProperties": {}
},
"Comment": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"content": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"content"
],
"additionalProperties": {}
},
"CommentInput": {
"type": "object",
"properties": {
"content": {
"type": "string",
"minLength": 1,
"maxLength": 1000000
}
},
"required": [
"content"
]
},
"ClientVisibilityInput": {
"type": "object",
"properties": {
"visible_to_clients": {
"type": "boolean"
}
},
"required": [
"visible_to_clients"
]
},
"Event": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"recording_id": {
"type": "number"
},
"action": {
"type": "string"
},
"details": {
"type": "object",
"additionalProperties": {}
},
"created_at": {
"type": "string"
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
}
},
"required": [
"id",
"recording_id",
"action",
"details",
"created_at",
"creator"
],
"additionalProperties": {}
},
"BoostInput": {
"type": "object",
"properties": {
"content": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"content"
]
},
"Subscription": {
"type": "object",
"properties": {
"subscribed": {
"type": "boolean"
},
"count": {
"type": "number"
},
"url": {
"type": "string"
},
"subscribers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
}
},
"required": [
"subscribed",
"count",
"url",
"subscribers"
],
"additionalProperties": {}
},
"SubscriptionInput": {
"type": "object",
"properties": {
"subscriptions": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
},
"unsubscriptions": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
}
}
},
"BookmarkStatus": {
"type": "object",
"properties": {
"bookmarked": {
"type": "boolean"
}
},
"required": [
"bookmarked"
],
"additionalProperties": {}
},
"Todoset": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"todolists_count": {
"type": "number"
},
"todolists_url": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"todolists_count",
"todolists_url"
],
"additionalProperties": {}
},
"Todolist": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"completed": {
"type": "boolean"
},
"completed_ratio": {
"type": "string"
},
"todos_url": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"name",
"description",
"completed",
"completed_ratio",
"todos_url"
],
"additionalProperties": {}
},
"TodolistInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"description": {
"type": "string",
"maxLength": 1000000
}
},
"required": [
"name"
]
},
"Position": {
"type": "object",
"properties": {
"position": {
"type": "integer",
"minimum": 1
}
},
"required": [
"position"
]
},
"TodolistGroupInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"color": {
"type": "string"
}
},
"required": [
"name"
]
},
"Todo": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"content": {
"type": "string"
},
"description": {
"type": "string"
},
"completed": {
"type": "boolean"
},
"due_on": {
"type": [
"string",
"null"
]
},
"starts_on": {
"type": [
"string",
"null"
]
},
"assignees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"content",
"description",
"completed",
"due_on",
"starts_on",
"assignees"
],
"additionalProperties": {}
},
"TodoInput": {
"type": "object",
"properties": {
"content": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"description": {
"type": "string",
"maxLength": 1000000
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
},
"completion_subscriber_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
},
"notify": {
"type": "boolean"
},
"due_on": {
"type": [
"string",
"null"
],
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"starts_on": {
"type": [
"string",
"null"
],
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"content"
]
},
"TodolistUpdate": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"description": {
"type": "string",
"maxLength": 1000000
}
}
},
"TodoPosition": {
"type": "object",
"properties": {
"position": {
"type": "integer",
"minimum": 1
},
"parent_id": {
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": [
"position"
]
},
"CardStep": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"due_on": {
"type": [
"string",
"null"
]
},
"completed": {
"type": "boolean"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"due_on",
"completed"
],
"additionalProperties": {}
},
"SubtaskInput": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"due_on": {
"type": [
"string",
"null"
],
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
}
},
"required": [
"title"
]
},
"SubtaskUpdate": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"due_on": {
"type": [
"string",
"null"
],
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
}
}
},
"MessageBoard": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"messages_count": {
"type": "number"
},
"messages_url": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"messages_count",
"messages_url"
],
"additionalProperties": {}
},
"Message": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"subject": {
"type": "string"
},
"content": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"subject",
"content"
],
"additionalProperties": {}
},
"MessageInput": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"content": {
"type": "string",
"maxLength": 1000000
},
"status": {
"type": "string",
"enum": [
"active",
"drafted"
]
},
"category_id": {
"type": [
"integer",
"null"
],
"exclusiveMinimum": 0
},
"subscriptions": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 500
}
},
"required": [
"subject"
]
},
"MessageUpdate": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"content": {
"type": "string",
"maxLength": 1000000
},
"status": {
"type": "string",
"enum": [
"active",
"drafted"
]
},
"category_id": {
"type": [
"integer",
"null"
],
"exclusiveMinimum": 0
},
"subscriptions": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 500
}
}
},
"MessageType": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name",
"icon",
"created_at",
"updated_at"
],
"additionalProperties": {}
},
"MessageTypeInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"icon": {
"type": "string",
"minLength": 1,
"maxLength": 16
}
},
"required": [
"name",
"icon"
]
},
"MessageTypeUpdate": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"icon": {
"type": "string",
"minLength": 1,
"maxLength": 16
}
}
},
"AttachmentCreated": {
"type": "object",
"properties": {
"attachable_sgid": {
"type": "string"
}
},
"required": [
"attachable_sgid"
],
"additionalProperties": {}
},
"Vault": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"documents_count": {
"type": "number"
},
"uploads_count": {
"type": "number"
},
"vaults_count": {
"type": "number"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"documents_count",
"uploads_count",
"vaults_count"
],
"additionalProperties": {}
},
"VaultInput": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"title"
]
},
"Document": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"content": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"content"
],
"additionalProperties": {}
},
"DocumentInput": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"content": {
"type": "string",
"maxLength": 1000000
},
"status": {
"type": "string",
"enum": [
"active",
"drafted"
]
}
},
"required": [
"title"
]
},
"Upload": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"filename": {
"type": "string"
},
"content_type": {
"type": "string"
},
"byte_size": {
"type": "number"
},
"download_url": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"filename",
"content_type",
"byte_size",
"download_url"
],
"additionalProperties": {}
},
"UploadInput": {
"type": "object",
"properties": {
"attachable_sgid": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"description": {
"type": "string",
"maxLength": 1000000
},
"base_name": {
"type": "string",
"maxLength": 255
}
},
"required": [
"attachable_sgid"
]
},
"DocumentUpdate": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"content": {
"type": "string",
"maxLength": 1000000
},
"status": {
"type": "string",
"enum": [
"active",
"drafted"
]
}
}
},
"UploadUpdate": {
"type": "object",
"properties": {
"description": {
"type": "string",
"maxLength": 1000000
},
"base_name": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
},
"CloudFile": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"service": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"service"
],
"additionalProperties": {}
},
"CloudFileInput": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"link": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"title",
"link"
]
},
"Schedule": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"entries_count": {
"type": "number"
},
"entries_url": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"entries_count",
"entries_url"
],
"additionalProperties": {}
},
"ScheduleSettingsInput": {
"type": "object",
"properties": {
"include_due_assignments": {
"type": "boolean"
}
},
"required": [
"include_due_assignments"
]
},
"ScheduleEntry": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"summary": {
"type": "string"
},
"all_day": {
"type": "boolean"
},
"starts_at": {
"type": "string"
},
"ends_at": {
"type": "string"
},
"participants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"summary",
"all_day",
"starts_at",
"ends_at",
"participants"
],
"additionalProperties": {}
},
"ScheduleEntryInput": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"starts_at": {
"type": "string",
"minLength": 10,
"maxLength": 40
},
"ends_at": {
"type": "string",
"minLength": 10,
"maxLength": 40
},
"description": {
"type": "string",
"maxLength": 1000000
},
"participant_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
},
"all_day": {
"type": "boolean"
},
"notify": {
"type": "boolean"
}
},
"required": [
"summary",
"starts_at",
"ends_at"
]
},
"ScheduleEntryUpdate": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"starts_at": {
"type": "string",
"minLength": 10,
"maxLength": 40
},
"ends_at": {
"type": "string",
"minLength": 10,
"maxLength": 40
},
"description": {
"type": "string",
"maxLength": 1000000
},
"participant_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
},
"all_day": {
"type": "boolean"
},
"notify": {
"type": "boolean"
}
}
},
"CardColumn": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"color": {
"type": [
"string",
"null"
]
},
"cards_count": {
"type": "number"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"color",
"cards_count"
],
"additionalProperties": {}
},
"CardColumnUpdate": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 100000
}
}
},
"CardColumnColor": {
"type": "object",
"properties": {
"color": {
"type": "string",
"enum": [
"white",
"red",
"orange",
"yellow",
"green",
"blue",
"aqua",
"purple",
"gray",
"pink",
"brown"
]
}
},
"required": [
"color"
]
},
"Card": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"content": {
"type": "string"
},
"due_on": {
"type": [
"string",
"null"
]
},
"completed": {
"type": "boolean"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"content",
"due_on",
"completed"
],
"additionalProperties": {}
},
"CardInput": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"content": {
"type": "string",
"maxLength": 1000000
},
"due_on": {
"type": [
"string",
"null"
],
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
},
"notify": {
"type": "boolean"
}
},
"required": [
"title"
]
},
"CardUpdate": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"content": {
"type": "string",
"maxLength": 1000000
},
"due_on": {
"type": [
"string",
"null"
],
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
},
"notify": {
"type": "boolean"
}
}
},
"CardMove": {
"type": "object",
"properties": {
"column_id": {
"type": "integer",
"exclusiveMinimum": 0
},
"position": {
"type": "integer",
"minimum": 1
}
},
"required": [
"column_id"
]
},
"CardStepInput": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"due_on": {
"type": [
"string",
"null"
],
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
}
},
"required": [
"title"
]
},
"CardStepPosition": {
"type": "object",
"properties": {
"source_id": {
"type": "integer",
"exclusiveMinimum": 0
},
"position": {
"type": "integer",
"minimum": 1
}
},
"required": [
"source_id",
"position"
]
},
"CardStepUpdate": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"due_on": {
"type": [
"string",
"null"
],
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
}
}
},
"CardStepCompletion": {
"type": "object",
"properties": {
"completion": {
"type": "string"
}
},
"required": [
"completion"
]
},
"CardTable": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"lists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recording"
}
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"lists"
],
"additionalProperties": {}
},
"CardColumnInput": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 100000
}
},
"required": [
"title"
]
},
"CardColumnMove": {
"type": "object",
"properties": {
"source_id": {
"type": "integer",
"exclusiveMinimum": 0
},
"target_id": {
"type": "integer",
"exclusiveMinimum": 0
},
"position": {
"type": "integer",
"minimum": 1
}
},
"required": [
"source_id",
"target_id"
]
},
"Campfire": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"topic": {
"type": "string"
},
"lines_url": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"topic",
"lines_url"
],
"additionalProperties": {}
},
"PingInput": {
"type": "object",
"properties": {
"person_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"minItems": 1,
"maxItems": 200
}
},
"required": [
"person_ids"
]
},
"CampfireLine": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"content": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"content"
],
"additionalProperties": {}
},
"CampfireLineInput": {
"type": "object",
"properties": {
"content": {
"type": "string",
"minLength": 1,
"maxLength": 100000
},
"content_type": {
"type": "string"
}
},
"required": [
"content"
]
},
"Inbox": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"forwards_count": {
"type": "number"
},
"forwards_url": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"forwards_count",
"forwards_url"
],
"additionalProperties": {}
},
"Forward": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"subject": {
"type": "string"
},
"from": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"subject",
"from"
],
"additionalProperties": {}
},
"ForwardReply": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"content": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"content"
],
"additionalProperties": {}
},
"ForwardReplyInput": {
"type": "object",
"properties": {
"content": {
"type": "string",
"minLength": 1,
"maxLength": 1000000
}
},
"required": [
"content"
]
},
"Questionnaire": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"questions_count": {
"type": "number"
},
"questions_url": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"questions_count",
"questions_url"
],
"additionalProperties": {}
},
"Question": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"paused": {
"type": "boolean"
},
"answers_count": {
"type": "number"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"paused",
"answers_count"
],
"additionalProperties": {}
},
"QuestionInput": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"schedule": {
"$ref": "#/components/schemas/QuestionScheduleInput"
},
"participant_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
}
},
"required": [
"title"
]
},
"QuestionScheduleInput": {
"type": "object",
"properties": {
"frequency": {
"type": "string"
},
"days": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 6
},
"minItems": 1,
"maxItems": 7
},
"hour": {
"type": "integer",
"minimum": 0,
"maximum": 23
},
"minute": {
"type": "integer",
"minimum": 0,
"maximum": 59
}
}
},
"QuestionUpdate": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"schedule": {
"$ref": "#/components/schemas/QuestionScheduleInput"
},
"participant_ids": {
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0
},
"maxItems": 200
}
}
},
"QuestionAnswer": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"visible_to_clients": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"title": {
"type": "string"
},
"inherits_status": {
"type": "boolean"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
}
},
"required": [
"id",
"title",
"type",
"url",
"app_url"
]
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"Project"
]
}
},
"required": [
"id",
"name",
"type"
]
},
"creator": {
"allOf": [
{
"$ref": "#/components/schemas/Person"
},
{
"type": [
"object",
"null"
]
}
]
},
"content": {
"type": "string"
},
"group_on": {
"type": "string"
}
},
"required": [
"id",
"status",
"visible_to_clients",
"created_at",
"updated_at",
"title",
"inherits_status",
"type",
"url",
"app_url",
"bucket",
"creator",
"content",
"group_on"
],
"additionalProperties": {}
},
"QuestionAnswerInput": {
"type": "object",
"properties": {
"content": {
"type": "string",
"minLength": 1,
"maxLength": 1000000
},
"group_on": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"content"
]
},
"QuestionAnswerUpdate": {
"type": "object",
"properties": {
"content": {
"type": "string",
"minLength": 1,
"maxLength": 1000000
}
},
"required": [
"content"
]
},
"Webhook": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"active": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"payload_url": {
"type": "string"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"app_url": {
"type": "string"
},
"recent_deliveries": {
"type": "array",
"items": {}
}
},
"required": [
"id",
"active",
"created_at",
"updated_at",
"payload_url",
"types",
"url",
"app_url"
],
"additionalProperties": {}
},
"WebhookInput": {
"type": "object",
"properties": {
"payload_url": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 50
},
"active": {
"type": "boolean"
}
},
"required": [
"payload_url"
]
},
"WebhookUpdate": {
"type": "object",
"properties": {
"payload_url": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 50
},
"active": {
"type": "boolean"
}
}
}
},
"parameters": {}
}