Enjazy Server API
REST API over the shared Enjazy core — lists, tasks, sub-tasks, tags, projects, comments and the activity log — plus the offline-first sync channel and outbound webhooks. The `/api/*` surface can be locked with an API key (set `ENJAZY_API_KEYS`); `/api/sync/*` stays public unless `ENJAZY_API_KEYS_SYNC=true`, and `/health` and `/docs/json` are always public.
Base URL
https://the.enjazy.appThe reference is in English.lists9 operations
GET/api/listsList every list
Responses
200Default Response
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer"
},
"parentId": {
"type": "string",
"nullable": true,
"enum": [
null
]
},
"dueDate": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"title",
"color",
"order",
"parentId",
"dueDate",
"isDefault",
"isSample",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/lists
Request body
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1
},
"color": {
"type": "string",
"nullable": true
},
"parentId": {
"type": "string",
"nullable": true,
"enum": [
null
]
}
},
"required": [
"title"
],
"additionalProperties": false
}Responses
201Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer"
},
"parentId": {
"type": "string",
"nullable": true,
"enum": [
null
]
},
"dueDate": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"title",
"color",
"order",
"parentId",
"dueDate",
"isDefault",
"isSample",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/lists/{id}
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer"
},
"parentId": {
"type": "string",
"nullable": true,
"enum": [
null
]
},
"dueDate": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"title",
"color",
"order",
"parentId",
"dueDate",
"isDefault",
"isSample",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}PATCH/api/lists/{id}
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1
},
"color": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer"
}
},
"required": [],
"additionalProperties": true
}Responses
200Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer"
},
"parentId": {
"type": "string",
"nullable": true,
"enum": [
null
]
},
"dueDate": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"title",
"color",
"order",
"parentId",
"dueDate",
"isDefault",
"isSample",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}DELETE/api/lists/{id}
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/lists/{id}/tasks
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"listId": {
"type": "string",
"minLength": 1
},
"parentId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"title": {
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"minLength": 1
},
"importance": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"urgency": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"effort": {
"type": "integer",
"minimum": 0
},
"startDate": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"dueTime": {
"type": "string",
"nullable": true
},
"dueLegacy": {
"type": "boolean"
},
"reminderOffsetMin": {
"type": "integer",
"nullable": true
},
"recurrence": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"order": {
"type": "integer"
},
"completedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"autoComplete": {
"type": "boolean"
},
"estimateSeconds": {
"type": "integer",
"minimum": 0,
"nullable": true
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"name",
"color"
],
"additionalProperties": false
}
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"listId",
"parentId",
"title",
"notes",
"status",
"importance",
"urgency",
"effort",
"startDate",
"dueDate",
"dueTime",
"dueLegacy",
"reminderOffsetMin",
"recurrence",
"order",
"completedAt",
"autoComplete",
"estimateSeconds",
"isSample",
"extra",
"tags",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/lists/{id}/reorder
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"orderedTaskIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"orderedTaskIds"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/lists/{id}/projects
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "array",
"items": {
"type": "string"
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}PUT/api/lists/{id}/projects
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"projectIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"projectIds"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}tasks16 operations
GET/api/tasks
Responses
200Default Response
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"listId": {
"type": "string",
"minLength": 1
},
"parentId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"title": {
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"minLength": 1
},
"importance": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"urgency": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"effort": {
"type": "integer",
"minimum": 0
},
"startDate": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"dueTime": {
"type": "string",
"nullable": true
},
"dueLegacy": {
"type": "boolean"
},
"reminderOffsetMin": {
"type": "integer",
"nullable": true
},
"recurrence": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"order": {
"type": "integer"
},
"completedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"autoComplete": {
"type": "boolean"
},
"estimateSeconds": {
"type": "integer",
"minimum": 0,
"nullable": true
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"name",
"color"
],
"additionalProperties": false
}
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"listId",
"parentId",
"title",
"notes",
"status",
"importance",
"urgency",
"effort",
"startDate",
"dueDate",
"dueTime",
"dueLegacy",
"reminderOffsetMin",
"recurrence",
"order",
"completedAt",
"autoComplete",
"estimateSeconds",
"isSample",
"extra",
"tags",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/tasks
Request body
{
"type": "object",
"properties": {
"listId": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"parentId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"notes": {
"type": "string",
"maxLength": 20000,
"nullable": true
},
"status": {
"type": "string",
"enum": [
"todo",
"in_progress",
"done"
]
},
"importance": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"urgency": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"effort": {
"type": "integer",
"minimum": 0
},
"startDate": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",
"nullable": true
},
"dueDate": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",
"nullable": true
},
"dueTime": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
"nullable": true
},
"reminderOffsetMin": {
"anyOf": [
{
"type": "number",
"enum": [
0
]
},
{
"type": "number",
"enum": [
5
]
},
{
"type": "number",
"enum": [
15
]
},
{
"type": "number",
"enum": [
30
]
},
{
"type": "number",
"enum": [
60
]
},
{
"type": "number",
"enum": [
1440
]
}
],
"nullable": true
},
"recurrence": {
"type": "object",
"properties": {
"freq": {
"type": "string",
"enum": [
"daily",
"weekly",
"monthly",
"yearly"
]
},
"interval": {
"type": "integer"
},
"byWeekday": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 6
}
},
"bySetPos": {
"anyOf": [
{
"type": "number",
"enum": [
-1
]
},
{
"type": "number",
"enum": [
1
]
},
{
"type": "number",
"enum": [
2
]
},
{
"type": "number",
"enum": [
3
]
},
{
"type": "number",
"enum": [
4
]
}
]
},
"count": {
"type": "integer",
"minimum": 1
},
"until": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
},
"anchor": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
}
},
"required": [
"freq",
"interval"
],
"additionalProperties": true,
"nullable": true
},
"order": {
"type": "integer"
},
"completedAt": {
"type": "string",
"nullable": true
},
"autoComplete": {
"type": "boolean"
},
"estimateSeconds": {
"type": "integer",
"minimum": 0,
"nullable": true
},
"isSample": {
"type": "boolean"
},
"id": {
"not": {}
},
"createdAt": {
"not": {}
},
"updatedAt": {
"not": {}
},
"deletedAt": {
"not": {}
},
"extra": {
"not": {}
}
},
"required": [
"listId",
"title"
],
"additionalProperties": false
}Responses
201Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"listId": {
"type": "string",
"minLength": 1
},
"parentId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"title": {
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"minLength": 1
},
"importance": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"urgency": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"effort": {
"type": "integer",
"minimum": 0
},
"startDate": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"dueTime": {
"type": "string",
"nullable": true
},
"dueLegacy": {
"type": "boolean"
},
"reminderOffsetMin": {
"type": "integer",
"nullable": true
},
"recurrence": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"order": {
"type": "integer"
},
"completedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"autoComplete": {
"type": "boolean"
},
"estimateSeconds": {
"type": "integer",
"minimum": 0,
"nullable": true
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"name",
"color"
],
"additionalProperties": false
}
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"listId",
"parentId",
"title",
"notes",
"status",
"importance",
"urgency",
"effort",
"startDate",
"dueDate",
"dueTime",
"dueLegacy",
"reminderOffsetMin",
"recurrence",
"order",
"completedAt",
"autoComplete",
"estimateSeconds",
"isSample",
"extra",
"tags",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/tasks/{id}/subtasks
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"listId": {
"type": "string",
"minLength": 1
},
"parentId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"title": {
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"minLength": 1
},
"importance": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"urgency": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"effort": {
"type": "integer",
"minimum": 0
},
"startDate": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"dueTime": {
"type": "string",
"nullable": true
},
"dueLegacy": {
"type": "boolean"
},
"reminderOffsetMin": {
"type": "integer",
"nullable": true
},
"recurrence": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"order": {
"type": "integer"
},
"completedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"autoComplete": {
"type": "boolean"
},
"estimateSeconds": {
"type": "integer",
"minimum": 0,
"nullable": true
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"name",
"color"
],
"additionalProperties": false
}
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"listId",
"parentId",
"title",
"notes",
"status",
"importance",
"urgency",
"effort",
"startDate",
"dueDate",
"dueTime",
"dueLegacy",
"reminderOffsetMin",
"recurrence",
"order",
"completedAt",
"autoComplete",
"estimateSeconds",
"isSample",
"extra",
"tags",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/tasks/{id}/lists
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer"
},
"parentId": {
"type": "string",
"nullable": true,
"enum": [
null
]
},
"dueDate": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"title",
"color",
"order",
"parentId",
"dueDate",
"isDefault",
"isSample",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}PUT/api/tasks/{id}/lists
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"listIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"listIds"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/tasks/{id}
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"listId": {
"type": "string",
"minLength": 1
},
"parentId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"title": {
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"minLength": 1
},
"importance": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"urgency": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"effort": {
"type": "integer",
"minimum": 0
},
"startDate": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"dueTime": {
"type": "string",
"nullable": true
},
"dueLegacy": {
"type": "boolean"
},
"reminderOffsetMin": {
"type": "integer",
"nullable": true
},
"recurrence": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"order": {
"type": "integer"
},
"completedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"autoComplete": {
"type": "boolean"
},
"estimateSeconds": {
"type": "integer",
"minimum": 0,
"nullable": true
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"name",
"color"
],
"additionalProperties": false
}
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"listId",
"parentId",
"title",
"notes",
"status",
"importance",
"urgency",
"effort",
"startDate",
"dueDate",
"dueTime",
"dueLegacy",
"reminderOffsetMin",
"recurrence",
"order",
"completedAt",
"autoComplete",
"estimateSeconds",
"isSample",
"extra",
"tags",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}PATCH/api/tasks/{id}
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1
},
"notes": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"todo",
"in_progress",
"done"
]
},
"importance": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"urgency": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"effort": {
"type": "integer",
"minimum": 0
},
"startDate": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",
"nullable": true
},
"dueDate": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",
"nullable": true
},
"dueTime": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
"nullable": true
},
"reminderOffsetMin": {
"anyOf": [
{
"type": "number",
"enum": [
0
]
},
{
"type": "number",
"enum": [
5
]
},
{
"type": "number",
"enum": [
15
]
},
{
"type": "number",
"enum": [
30
]
},
{
"type": "number",
"enum": [
60
]
},
{
"type": "number",
"enum": [
1440
]
}
],
"nullable": true
},
"recurrence": {
"type": "object",
"properties": {
"freq": {
"type": "string",
"enum": [
"daily",
"weekly",
"monthly",
"yearly"
]
},
"interval": {
"type": "integer"
},
"byWeekday": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 6
}
},
"bySetPos": {
"anyOf": [
{
"type": "number",
"enum": [
-1
]
},
{
"type": "number",
"enum": [
1
]
},
{
"type": "number",
"enum": [
2
]
},
{
"type": "number",
"enum": [
3
]
},
{
"type": "number",
"enum": [
4
]
}
]
},
"count": {
"type": "integer",
"minimum": 1
},
"until": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
},
"anchor": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
}
},
"required": [
"freq",
"interval"
],
"additionalProperties": true,
"nullable": true
},
"completedAt": {
"type": "string",
"nullable": true
},
"autoComplete": {
"type": "boolean"
},
"estimateSeconds": {
"type": "integer",
"minimum": 0,
"nullable": true
},
"order": {
"type": "integer"
},
"listId": {
"description": "Arbitrary JSON value"
},
"parentId": {
"description": "Arbitrary JSON value"
},
"tags": {
"description": "Arbitrary JSON value"
},
"id": {
"not": {}
},
"createdAt": {
"not": {}
},
"updatedAt": {
"not": {}
},
"deletedAt": {
"not": {}
},
"extra": {
"not": {}
}
},
"required": [],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"listId": {
"type": "string",
"minLength": 1
},
"parentId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"title": {
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"minLength": 1
},
"importance": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"urgency": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"effort": {
"type": "integer",
"minimum": 0
},
"startDate": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"dueTime": {
"type": "string",
"nullable": true
},
"dueLegacy": {
"type": "boolean"
},
"reminderOffsetMin": {
"type": "integer",
"nullable": true
},
"recurrence": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"order": {
"type": "integer"
},
"completedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"autoComplete": {
"type": "boolean"
},
"estimateSeconds": {
"type": "integer",
"minimum": 0,
"nullable": true
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"name",
"color"
],
"additionalProperties": false
}
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"listId",
"parentId",
"title",
"notes",
"status",
"importance",
"urgency",
"effort",
"startDate",
"dueDate",
"dueTime",
"dueLegacy",
"reminderOffsetMin",
"recurrence",
"order",
"completedAt",
"autoComplete",
"estimateSeconds",
"isSample",
"extra",
"tags",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}DELETE/api/tasks/{id}
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/tasks/{id}/status
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"todo",
"in_progress",
"done"
]
}
},
"required": [
"status"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"listId": {
"type": "string",
"minLength": 1
},
"parentId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"title": {
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"minLength": 1
},
"importance": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"urgency": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"effort": {
"type": "integer",
"minimum": 0
},
"startDate": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"dueTime": {
"type": "string",
"nullable": true
},
"dueLegacy": {
"type": "boolean"
},
"reminderOffsetMin": {
"type": "integer",
"nullable": true
},
"recurrence": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"order": {
"type": "integer"
},
"completedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"autoComplete": {
"type": "boolean"
},
"estimateSeconds": {
"type": "integer",
"minimum": 0,
"nullable": true
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"name",
"color"
],
"additionalProperties": false
}
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"listId",
"parentId",
"title",
"notes",
"status",
"importance",
"urgency",
"effort",
"startDate",
"dueDate",
"dueTime",
"dueLegacy",
"reminderOffsetMin",
"recurrence",
"order",
"completedAt",
"autoComplete",
"estimateSeconds",
"isSample",
"extra",
"tags",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/tasks/{id}/auto-complete
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"value": {
"type": "boolean"
}
},
"required": [
"value"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"listId": {
"type": "string",
"minLength": 1
},
"parentId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"title": {
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"minLength": 1
},
"importance": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"urgency": {
"type": "string",
"enum": [
"none",
"low",
"medium",
"high"
]
},
"effort": {
"type": "integer",
"minimum": 0
},
"startDate": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"dueTime": {
"type": "string",
"nullable": true
},
"dueLegacy": {
"type": "boolean"
},
"reminderOffsetMin": {
"type": "integer",
"nullable": true
},
"recurrence": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"order": {
"type": "integer"
},
"completedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"autoComplete": {
"type": "boolean"
},
"estimateSeconds": {
"type": "integer",
"minimum": 0,
"nullable": true
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"name",
"color"
],
"additionalProperties": false
}
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"listId",
"parentId",
"title",
"notes",
"status",
"importance",
"urgency",
"effort",
"startDate",
"dueDate",
"dueTime",
"dueLegacy",
"reminderOffsetMin",
"recurrence",
"order",
"completedAt",
"autoComplete",
"estimateSeconds",
"isSample",
"extra",
"tags",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/tasks/{id}/tags
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"tagId": {
"type": "string",
"minLength": 1
}
},
"required": [
"tagId"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}PUT/api/tasks/{id}/tags
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"tagIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"tagIds"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}DELETE/api/tasks/{id}/tags/{tagId}
Parameters
idpath · string · requiredtagIdpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/tasks/{id}/comments
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"taskId": {
"type": "string",
"minLength": 1
},
"body": {
"type": "string",
"minLength": 1
},
"authorId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"authorName": {
"type": "string",
"nullable": true
},
"editedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"taskId",
"body",
"authorId",
"authorName",
"editedAt",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/tasks/{id}/comments
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"body": {
"type": "string",
"minLength": 1,
"maxLength": 10000
}
},
"required": [
"body"
],
"additionalProperties": false
}Responses
201Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"taskId": {
"type": "string",
"minLength": 1
},
"body": {
"type": "string",
"minLength": 1
},
"authorId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"authorName": {
"type": "string",
"nullable": true
},
"editedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"taskId",
"body",
"authorId",
"authorName",
"editedAt",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/tasks/{id}/activity
Parameters
limitquery · integeroffsetquery · integeridpath · string · requiredResponses
200Default Response
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"minLength": 1
},
"entityType": {
"type": "string",
"minLength": 1
},
"entityId": {
"type": "string",
"minLength": 1
},
"taskId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"kind": {
"type": "string",
"minLength": 1
},
"payload": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
}
},
"actorId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"actorName": {
"type": "string",
"nullable": true
},
"actorGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
],
"nullable": true
}
},
"required": [
"id",
"at",
"entityType",
"entityId",
"taskId",
"kind",
"payload",
"actorId",
"actorName",
"actorGender"
],
"additionalProperties": true
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}tags3 operations
GET/api/tags
Responses
200Default Response
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"updatedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"name",
"color",
"isSample",
"extra",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/tags
Request body
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"color": {
"type": "string",
"nullable": true
}
},
"required": [
"name"
],
"additionalProperties": false
}Responses
201Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"nullable": true
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"updatedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"name",
"color",
"isSample",
"extra",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}DELETE/api/tags/{id}
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}projects8 operations
GET/api/projects
Responses
200Default Response
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"color": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer"
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"name",
"color",
"order",
"isSample",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/projects
Request body
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"color": {
"type": "string",
"nullable": true
}
},
"required": [
"name"
],
"additionalProperties": false
}Responses
201Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"color": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer"
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"name",
"color",
"order",
"isSample",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/projects/{id}
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"color": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer"
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"name",
"color",
"order",
"isSample",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}PATCH/api/projects/{id}
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"color": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer"
}
},
"required": [],
"additionalProperties": true
}Responses
200Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"color": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer"
},
"isSample": {
"type": "boolean"
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"name",
"color",
"order",
"isSample",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}DELETE/api/projects/{id}
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"keep": {
"type": "string",
"enum": [
"keep",
"all"
]
}
},
"required": [],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/projects/{id}/lists
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "array",
"items": {
"type": "string"
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/projects/{id}/lists
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"listId": {
"type": "string",
"minLength": 1
}
},
"required": [
"listId"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}DELETE/api/projects/{id}/lists/{listId}
Parameters
idpath · string · requiredlistIdpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}comments2 operations
PATCH/api/comments/{id}
Parameters
idpath · string · requiredRequest body
{
"type": "object",
"properties": {
"body": {
"type": "string",
"minLength": 1,
"maxLength": 10000
}
},
"required": [
"body"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"taskId": {
"type": "string",
"minLength": 1
},
"body": {
"type": "string",
"minLength": 1
},
"authorId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"authorName": {
"type": "string",
"nullable": true
},
"editedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"extra": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1,
"nullable": true
}
},
"required": [
"id",
"taskId",
"body",
"authorId",
"authorName",
"editedAt",
"extra",
"createdAt",
"updatedAt",
"deletedAt"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}DELETE/api/comments/{id}
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}activity2 operations
GET/api/activity
Parameters
kindsquery · stringsincequery · stringuntilquery · stringlimitquery · integeroffsetquery · integerResponses
200Default Response
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"minLength": 1
},
"entityType": {
"type": "string",
"minLength": 1
},
"entityId": {
"type": "string",
"minLength": 1
},
"taskId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"kind": {
"type": "string",
"minLength": 1
},
"payload": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
}
},
"actorId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"actorName": {
"type": "string",
"nullable": true
},
"actorGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
],
"nullable": true
}
},
"required": [
"id",
"at",
"entityType",
"entityId",
"taskId",
"kind",
"payload",
"actorId",
"actorName",
"actorGender"
],
"additionalProperties": true
}
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/activity
Request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"minLength": 1
},
"entityType": {
"type": "string",
"enum": [
"task",
"list",
"project",
"comment"
]
},
"entityId": {
"type": "string",
"minLength": 1
},
"taskId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"kind": {
"type": "string",
"enum": [
"taskCreated",
"taskDeleted",
"statusChanged",
"edited",
"moved",
"recurrenceRolled",
"timerStarted",
"timerStopped",
"commentAdded",
"commentEdited",
"commentDeleted",
"tagAdded",
"tagRemoved",
"listMembershipChanged",
"projectMembershipChanged",
"done",
"dependencyLinked",
"dependencyUnlinked",
"timeAdjusted",
"timerPaused",
"timerResumed",
"idleTimeKept",
"idleTimeDiscarded"
]
},
"payload": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
}
}
},
"required": [
"entityType",
"entityId",
"kind",
"payload"
],
"additionalProperties": false
}Responses
201Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"minLength": 1
},
"entityType": {
"type": "string",
"minLength": 1
},
"entityId": {
"type": "string",
"minLength": 1
},
"taskId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"kind": {
"type": "string",
"minLength": 1
},
"payload": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
}
},
"actorId": {
"type": "string",
"minLength": 1,
"nullable": true
},
"actorName": {
"type": "string",
"nullable": true
},
"actorGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
],
"nullable": true
}
},
"required": [
"id",
"at",
"entityType",
"entityId",
"taskId",
"kind",
"payload",
"actorId",
"actorName",
"actorGender"
],
"additionalProperties": true
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}sync5 operations
POST/api/sync/push
Parameters
protoquery · integerRequest body
{
"anyOf": [
{
"type": "object",
"properties": {
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entity": {
"type": "string",
"minLength": 1
},
"id": {
"type": "string",
"minLength": 1
},
"op": {
"type": "string",
"enum": [
"put",
"delete"
]
},
"data": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"updatedAt": {
"type": "string"
},
"origin": {
"type": "string",
"minLength": 1
}
},
"required": [
"entity",
"id",
"op",
"data",
"updatedAt",
"origin"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 5000
}
},
"required": [
"changes"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entity": {
"type": "string",
"minLength": 1
},
"id": {
"type": "string",
"minLength": 1
},
"op": {
"type": "string",
"enum": [
"put",
"delete"
]
},
"data": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"updatedAt": {
"type": "string"
},
"origin": {
"type": "string",
"minLength": 1
}
},
"required": [
"entity",
"id",
"op",
"data",
"updatedAt",
"origin"
],
"additionalProperties": false
},
"maxItems": 5000
}
},
"required": [
"changes"
],
"additionalProperties": false
}
]
}Responses
200Default Response
{
"anyOf": [
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": 0
},
"accepted": {
"type": "integer",
"minimum": 0
},
"ignored": {
"type": "integer",
"minimum": 0
}
},
"required": [
"seq",
"accepted",
"ignored"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"seq": {
"type": "integer",
"minimum": 0
}
},
"required": [
"seq"
],
"additionalProperties": false
}
]
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/sync/pull
Parameters
sincequery · integerlimitquery · integerprotoquery · integerResponses
200Default Response
{
"anyOf": [
{
"type": "object",
"properties": {
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entity": {
"type": "string",
"minLength": 1
},
"id": {
"type": "string",
"minLength": 1
},
"op": {
"type": "string",
"enum": [
"put",
"delete"
]
},
"data": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"updatedAt": {
"type": "string"
},
"origin": {
"type": "string",
"minLength": 1
}
},
"required": [
"entity",
"id",
"op",
"data",
"updatedAt",
"origin"
],
"additionalProperties": false
}
},
"seq": {
"type": "integer",
"minimum": 0
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"changes",
"seq",
"hasMore"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entity": {
"type": "string",
"minLength": 1
},
"id": {
"type": "string",
"minLength": 1
},
"op": {
"type": "string",
"enum": [
"put",
"delete"
]
},
"data": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"updatedAt": {
"type": "string"
},
"origin": {
"type": "string",
"minLength": 1
}
},
"required": [
"entity",
"id",
"op",
"data",
"updatedAt",
"origin"
],
"additionalProperties": false
}
},
"seq": {
"type": "integer",
"minimum": 0
}
},
"required": [
"changes",
"seq"
],
"additionalProperties": false
}
]
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/sync/count
Parameters
sincequery · integerResponses
200Default Response
{
"type": "object",
"properties": {
"changes": {
"type": "integer",
"minimum": 0
},
"tasks": {
"type": "integer",
"minimum": 0
}
},
"required": [
"changes",
"tasks"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/sync/snapshot
Parameters
protoquery · integerResponses
200Default Response
{
"type": "object",
"properties": {
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entity": {
"type": "string",
"minLength": 1
},
"id": {
"type": "string",
"minLength": 1
},
"op": {
"type": "string",
"enum": [
"put",
"delete"
]
},
"data": {
"type": "object",
"additionalProperties": {
"description": "Arbitrary JSON value"
},
"nullable": true
},
"updatedAt": {
"type": "string"
},
"origin": {
"type": "string",
"minLength": 1
}
},
"required": [
"entity",
"id",
"op",
"data",
"updatedAt",
"origin"
],
"additionalProperties": false
}
},
"seq": {
"type": "integer",
"minimum": 0
}
},
"required": [
"changes",
"seq"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/sync/deletions
Parameters
sincequery · integerlimitquery · integerResponses
200Default Response
{
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entity": {
"type": "string",
"minLength": 1
},
"id": {
"type": "string",
"minLength": 1
},
"deletedAt": {
"type": "string",
"minLength": 1
},
"seq": {
"type": "integer",
"minimum": 0
}
},
"required": [
"entity",
"id",
"deletedAt",
"seq"
],
"additionalProperties": false
}
},
"next": {
"type": "integer",
"minimum": 0,
"nullable": true
}
},
"required": [
"records",
"next"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}health1 operation
GET/health
Responses
200Default Response
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"ok"
]
},
"service": {
"type": "string",
"enum": [
"enjazy-server"
]
},
"auth": {
"type": "string",
"enum": [
"public",
"api-key",
"accounts"
]
},
"version": {
"type": "string",
"minLength": 1
},
"schema": {
"type": "integer"
},
"schemaVersion": {
"type": "integer"
},
"sync": {
"type": "object",
"properties": {
"proto": {
"type": "number",
"enum": [
2
]
},
"entities": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"tombstones": {
"type": "boolean",
"enum": [
true
]
},
"deletions": {
"type": "boolean",
"enum": [
true
]
},
"count": {
"type": "boolean",
"enum": [
true
]
},
"paginated": {
"type": "boolean",
"enum": [
true
]
},
"pageLimitMax": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
}
},
"required": [
"proto",
"entities",
"tombstones",
"deletions",
"count",
"paginated",
"pageLimitMax"
],
"additionalProperties": false
},
"ai": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
}
},
"required": [
"available"
],
"additionalProperties": false
}
},
"required": [
"status",
"service",
"auth",
"version",
"schema",
"schemaVersion",
"sync"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}auth29 operations
GET/api/auth/config
Responses
200Default Response
{
"type": "object",
"properties": {
"signupsEnabled": {
"type": "boolean"
},
"mailConfigured": {
"type": "boolean"
},
"supportEmail": {
"type": "string",
"nullable": true
},
"planGates": {
"type": "string",
"enum": [
"off",
"legacy",
"all"
]
},
"webAppOrigin": {
"type": "string"
},
"siteLinks": {
"type": "object",
"properties": {
"privacy": {
"type": "string"
},
"terms": {
"type": "string"
},
"help": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
},
"version": {
"type": "string",
"minLength": 1
},
"schema": {
"type": "integer"
},
"passkeys": {
"type": "boolean"
},
"limits": {
"type": "object",
"properties": {
"passwordMin": {
"type": "integer"
},
"passwordMax": {
"type": "integer"
},
"mfaDigits": {
"type": "integer"
},
"totpPeriodSec": {
"type": "integer"
},
"totpWindowSteps": {
"type": "integer"
},
"mfaWindowMin": {
"type": "integer"
},
"recoveryCodeCount": {
"type": "integer"
},
"loginFailMax": {
"type": "integer"
},
"ipFailMax": {
"type": "integer"
},
"lockoutWindowMin": {
"type": "integer"
},
"lockoutMin": {
"type": "integer"
},
"resetLinkMin": {
"type": "integer"
},
"verifyLinkHours": {
"type": "integer"
},
"verifyCodeDigits": {
"type": "integer"
},
"verifyCodeTtlMin": {
"type": "integer"
},
"verifyCodeMaxAttempts": {
"type": "integer"
},
"inviteDays": {
"type": "integer"
},
"inviteCodeLen": {
"type": "integer"
},
"resendCooldownSec": {
"type": "integer"
},
"pinMin": {
"type": "integer"
},
"pinMax": {
"type": "integer"
}
},
"required": [
"passwordMin",
"passwordMax",
"mfaDigits",
"totpPeriodSec",
"totpWindowSteps",
"mfaWindowMin",
"recoveryCodeCount",
"loginFailMax",
"ipFailMax",
"lockoutWindowMin",
"lockoutMin",
"resetLinkMin",
"verifyLinkHours",
"verifyCodeDigits",
"verifyCodeTtlMin",
"verifyCodeMaxAttempts",
"inviteDays",
"inviteCodeLen",
"resendCooldownSec",
"pinMin",
"pinMax"
],
"additionalProperties": false
}
},
"required": [
"signupsEnabled",
"mailConfigured",
"supportEmail",
"planGates",
"siteLinks",
"version",
"schema",
"passkeys",
"limits"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/login
Request body
{
"type": "object",
"properties": {
"identifier": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"client": {
"type": "object",
"properties": {
"app": {
"type": "string",
"enum": [
"desktop",
"android",
"web",
"admin",
"cli",
"other"
]
},
"version": {
"type": "string"
},
"os": {
"type": "string"
},
"device": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"password"
],
"additionalProperties": false
}Responses
200Default Response
{
"anyOf": [
{
"type": "object",
"properties": {
"access_token": {
"type": "string",
"minLength": 1
},
"token_type": {
"type": "string",
"enum": [
"Bearer"
]
},
"expires_in": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
},
"refresh_token": {
"type": "string",
"minLength": 1
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string"
},
"email": {
"type": "string",
"nullable": true
},
"role": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"mfaEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"passwordChangedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"lastSignedInAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"emailVerifiedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"recoveryCodesLeft": {
"type": "integer",
"minimum": 0
},
"passkeyCount": {
"type": "integer",
"minimum": 0
},
"grammaticalGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"ar"
]
},
"digits": {
"type": "string",
"enum": [
"latn",
"arab"
]
},
"notifySharingEmails": {
"type": "boolean"
}
},
"required": [
"id",
"username",
"email",
"role",
"status",
"displayName",
"mfaEnabled",
"createdAt",
"updatedAt",
"passwordChangedAt",
"lastSignedInAt",
"emailVerifiedAt",
"recoveryCodesLeft",
"grammaticalGender",
"locale",
"digits",
"notifySharingEmails"
],
"additionalProperties": false
}
},
"required": [
"access_token",
"token_type",
"expires_in",
"refresh_token",
"user"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"mfa_required": {
"type": "boolean",
"enum": [
true
]
},
"mfa_token": {
"type": "string",
"minLength": 1
}
},
"required": [
"mfa_required",
"mfa_token"
],
"additionalProperties": false
}
]
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/login/totp
Request body
{
"type": "object",
"properties": {
"mfa_token": {
"type": "string"
},
"mfaToken": {
"type": "string"
},
"code": {
"type": "string"
},
"client": {
"type": "object",
"properties": {
"app": {
"type": "string",
"enum": [
"desktop",
"android",
"web",
"admin",
"cli",
"other"
]
},
"version": {
"type": "string"
},
"os": {
"type": "string"
},
"device": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"code"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"access_token": {
"type": "string",
"minLength": 1
},
"token_type": {
"type": "string",
"enum": [
"Bearer"
]
},
"expires_in": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
},
"refresh_token": {
"type": "string",
"minLength": 1
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string"
},
"email": {
"type": "string",
"nullable": true
},
"role": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"mfaEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"passwordChangedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"lastSignedInAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"emailVerifiedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"recoveryCodesLeft": {
"type": "integer",
"minimum": 0
},
"passkeyCount": {
"type": "integer",
"minimum": 0
},
"grammaticalGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"ar"
]
},
"digits": {
"type": "string",
"enum": [
"latn",
"arab"
]
},
"notifySharingEmails": {
"type": "boolean"
}
},
"required": [
"id",
"username",
"email",
"role",
"status",
"displayName",
"mfaEnabled",
"createdAt",
"updatedAt",
"passwordChangedAt",
"lastSignedInAt",
"emailVerifiedAt",
"recoveryCodesLeft",
"grammaticalGender",
"locale",
"digits",
"notifySharingEmails"
],
"additionalProperties": false
}
},
"required": [
"access_token",
"token_type",
"expires_in",
"refresh_token",
"user"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/refresh
Request body
{
"type": "object",
"properties": {
"refresh_token": {
"type": "string"
},
"refreshToken": {
"type": "string"
},
"client": {
"type": "object",
"properties": {
"app": {
"type": "string",
"enum": [
"desktop",
"android",
"web",
"admin",
"cli",
"other"
]
},
"version": {
"type": "string"
},
"os": {
"type": "string"
},
"device": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"access_token": {
"type": "string",
"minLength": 1
},
"token_type": {
"type": "string",
"enum": [
"Bearer"
]
},
"expires_in": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
},
"refresh_token": {
"type": "string",
"minLength": 1
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string"
},
"email": {
"type": "string",
"nullable": true
},
"role": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"mfaEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"passwordChangedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"lastSignedInAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"emailVerifiedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"recoveryCodesLeft": {
"type": "integer",
"minimum": 0
},
"passkeyCount": {
"type": "integer",
"minimum": 0
},
"grammaticalGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"ar"
]
},
"digits": {
"type": "string",
"enum": [
"latn",
"arab"
]
},
"notifySharingEmails": {
"type": "boolean"
}
},
"required": [
"id",
"username",
"email",
"role",
"status",
"displayName",
"mfaEnabled",
"createdAt",
"updatedAt",
"passwordChangedAt",
"lastSignedInAt",
"emailVerifiedAt",
"recoveryCodesLeft",
"grammaticalGender",
"locale",
"digits",
"notifySharingEmails"
],
"additionalProperties": false
}
},
"required": [
"access_token",
"token_type",
"expires_in",
"refresh_token",
"user"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/logout
Request body
{
"type": "object",
"properties": {
"refresh_token": {
"type": "string"
},
"refreshToken": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/signup
Request body
{
"type": "object",
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"displayName": {
"type": "string",
"nullable": true
},
"invite": {
"type": "string"
},
"inviteCode": {
"type": "string"
},
"plan": {
"type": "string"
},
"locale": {
"type": "string",
"enum": [
"en",
"ar"
]
},
"digits": {
"type": "string",
"enum": [
"latn",
"arab"
]
},
"client": {
"type": "object",
"properties": {
"app": {
"type": "string",
"enum": [
"desktop",
"android",
"web",
"admin",
"cli",
"other"
]
},
"version": {
"type": "string"
},
"os": {
"type": "string"
},
"device": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"email",
"password"
],
"additionalProperties": false
}Responses
201Default Response
{
"type": "object",
"properties": {
"access_token": {
"type": "string",
"minLength": 1
},
"token_type": {
"type": "string",
"enum": [
"Bearer"
]
},
"expires_in": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
},
"refresh_token": {
"type": "string",
"minLength": 1
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string"
},
"email": {
"type": "string",
"nullable": true
},
"role": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"mfaEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"passwordChangedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"lastSignedInAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"emailVerifiedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"recoveryCodesLeft": {
"type": "integer",
"minimum": 0
},
"passkeyCount": {
"type": "integer",
"minimum": 0
},
"grammaticalGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"ar"
]
},
"digits": {
"type": "string",
"enum": [
"latn",
"arab"
]
},
"notifySharingEmails": {
"type": "boolean"
}
},
"required": [
"id",
"username",
"email",
"role",
"status",
"displayName",
"mfaEnabled",
"createdAt",
"updatedAt",
"passwordChangedAt",
"lastSignedInAt",
"emailVerifiedAt",
"recoveryCodesLeft",
"grammaticalGender",
"locale",
"digits",
"notifySharingEmails"
],
"additionalProperties": false
}
},
"required": [
"access_token",
"token_type",
"expires_in",
"refresh_token",
"user"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/auth/me
Responses
200Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string"
},
"email": {
"type": "string",
"nullable": true
},
"role": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"mfaEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"passwordChangedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"lastSignedInAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"emailVerifiedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"recoveryCodesLeft": {
"type": "integer",
"minimum": 0
},
"passkeyCount": {
"type": "integer",
"minimum": 0
},
"grammaticalGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"ar"
]
},
"digits": {
"type": "string",
"enum": [
"latn",
"arab"
]
},
"notifySharingEmails": {
"type": "boolean"
}
},
"required": [
"id",
"username",
"email",
"role",
"status",
"displayName",
"mfaEnabled",
"createdAt",
"updatedAt",
"passwordChangedAt",
"lastSignedInAt",
"emailVerifiedAt",
"recoveryCodesLeft",
"grammaticalGender",
"locale",
"digits",
"notifySharingEmails"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}PATCH/api/auth/profile
Request body
{
"type": "object",
"properties": {
"displayName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"grammaticalGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"ar"
]
},
"digits": {
"type": "string",
"enum": [
"latn",
"arab"
]
},
"notifySharingEmails": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string"
},
"email": {
"type": "string",
"nullable": true
},
"role": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"mfaEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"passwordChangedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"lastSignedInAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"emailVerifiedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"recoveryCodesLeft": {
"type": "integer",
"minimum": 0
},
"passkeyCount": {
"type": "integer",
"minimum": 0
},
"grammaticalGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"ar"
]
},
"digits": {
"type": "string",
"enum": [
"latn",
"arab"
]
},
"notifySharingEmails": {
"type": "boolean"
}
},
"required": [
"id",
"username",
"email",
"role",
"status",
"displayName",
"mfaEnabled",
"createdAt",
"updatedAt",
"passwordChangedAt",
"lastSignedInAt",
"emailVerifiedAt",
"recoveryCodesLeft",
"grammaticalGender",
"locale",
"digits",
"notifySharingEmails"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/password
Request body
{
"type": "object",
"properties": {
"currentPassword": {
"type": "string"
},
"newPassword": {
"type": "string"
},
"client": {
"type": "object",
"properties": {
"app": {
"type": "string",
"enum": [
"desktop",
"android",
"web",
"admin",
"cli",
"other"
]
},
"version": {
"type": "string"
},
"os": {
"type": "string"
},
"device": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"currentPassword",
"newPassword"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"access_token": {
"type": "string",
"minLength": 1
},
"token_type": {
"type": "string",
"enum": [
"Bearer"
]
},
"expires_in": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
},
"refresh_token": {
"type": "string",
"minLength": 1
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string"
},
"email": {
"type": "string",
"nullable": true
},
"role": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"mfaEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"passwordChangedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"lastSignedInAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"emailVerifiedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"recoveryCodesLeft": {
"type": "integer",
"minimum": 0
},
"passkeyCount": {
"type": "integer",
"minimum": 0
},
"grammaticalGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"ar"
]
},
"digits": {
"type": "string",
"enum": [
"latn",
"arab"
]
},
"notifySharingEmails": {
"type": "boolean"
}
},
"required": [
"id",
"username",
"email",
"role",
"status",
"displayName",
"mfaEnabled",
"createdAt",
"updatedAt",
"passwordChangedAt",
"lastSignedInAt",
"emailVerifiedAt",
"recoveryCodesLeft",
"grammaticalGender",
"locale",
"digits",
"notifySharingEmails"
],
"additionalProperties": false
}
},
"required": [
"access_token",
"token_type",
"expires_in",
"refresh_token",
"user"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/password/forgot
Request body
{
"type": "object",
"properties": {
"email": {
"type": "string"
},
"lang": {
"type": "string",
"enum": [
"en",
"ar"
]
}
},
"required": [
"email"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/password/reset
Request body
{
"type": "object",
"properties": {
"token": {
"type": "string"
},
"newPassword": {
"type": "string"
}
},
"required": [
"token",
"newPassword"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/email/verify/send
Responses
200Default Response
{
"type": "object",
"properties": {
"sent": {
"type": "boolean"
},
"alreadyVerified": {
"type": "boolean"
}
},
"required": [
"sent"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/email/verify
Request body
{
"anyOf": [
{
"type": "object",
"properties": {
"token": {
"type": "string",
"minLength": 1
}
},
"required": [
"token"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"email": {
"type": "string"
},
"code": {
"type": "string"
}
},
"required": [
"email",
"code"
],
"additionalProperties": false
}
]
}Responses
200Default Response
{
"type": "object",
"properties": {
"emailVerifiedAt": {
"type": "string"
}
},
"required": [
"emailVerifiedAt"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/email/verify/resend
Request body
{
"anyOf": [
{
"type": "object",
"properties": {
"token": {
"type": "string",
"minLength": 1
}
},
"required": [
"token"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"additionalProperties": false
}
]
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/auth/sessions
Responses
200Default Response
{
"type": "object",
"properties": {
"sessions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"userId": {
"type": "string",
"minLength": 1
},
"app": {
"type": "string",
"enum": [
"desktop",
"android",
"web",
"admin",
"cli",
"other"
]
},
"appVersion": {
"type": "string",
"nullable": true
},
"clientName": {
"type": "string",
"nullable": true
},
"clientVersion": {
"type": "string",
"nullable": true
},
"os": {
"type": "string",
"nullable": true
},
"device": {
"type": "string",
"nullable": true
},
"userAgent": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"minLength": 1
},
"lastUsedAt": {
"type": "string",
"minLength": 1
},
"expiresAt": {
"type": "string",
"minLength": 1
},
"current": {
"type": "boolean"
}
},
"required": [
"id",
"userId",
"app",
"appVersion",
"clientName",
"clientVersion",
"os",
"device",
"userAgent",
"createdAt",
"lastUsedAt",
"expiresAt",
"current"
],
"additionalProperties": false
}
}
},
"required": [
"sessions"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}DELETE/api/auth/sessions/{id}
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/sessions/revoke-others
Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
},
"revoked": {
"type": "integer"
}
},
"required": [
"ok",
"revoked"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/sessions/revoke-all
Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/session/from-sso
Request body
{
"type": "object",
"properties": {
"client": {
"type": "object",
"properties": {
"app": {
"type": "string",
"enum": [
"desktop",
"android",
"web",
"admin",
"cli",
"other"
]
},
"version": {
"type": "string"
},
"os": {
"type": "string"
},
"device": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"access_token": {
"type": "string",
"minLength": 1
},
"token_type": {
"type": "string",
"enum": [
"Bearer"
]
},
"expires_in": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
},
"refresh_token": {
"type": "string",
"minLength": 1
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string"
},
"email": {
"type": "string",
"nullable": true
},
"role": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"mfaEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"passwordChangedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"lastSignedInAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"emailVerifiedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"recoveryCodesLeft": {
"type": "integer",
"minimum": 0
},
"passkeyCount": {
"type": "integer",
"minimum": 0
},
"grammaticalGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"ar"
]
},
"digits": {
"type": "string",
"enum": [
"latn",
"arab"
]
},
"notifySharingEmails": {
"type": "boolean"
}
},
"required": [
"id",
"username",
"email",
"role",
"status",
"displayName",
"mfaEnabled",
"createdAt",
"updatedAt",
"passwordChangedAt",
"lastSignedInAt",
"emailVerifiedAt",
"recoveryCodesLeft",
"grammaticalGender",
"locale",
"digits",
"notifySharingEmails"
],
"additionalProperties": false
}
},
"required": [
"access_token",
"token_type",
"expires_in",
"refresh_token",
"user"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/totp/enroll
Responses
200Default Response
{
"type": "object",
"properties": {
"secret": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"secret",
"uri"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/totp/activate
Request body
{
"type": "object",
"properties": {
"code": {
"type": "string"
}
},
"required": [
"code"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"recoveryCodes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"recoveryCodes"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/totp/disable
Request body
{
"type": "object",
"properties": {
"code": {
"type": "string"
}
},
"required": [
"code"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/totp/recovery-codes
Responses
200Default Response
{
"type": "object",
"properties": {
"recoveryCodes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"recoveryCodes"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/passkeys/register/options
Responses
200Default Response
{
"type": "object",
"properties": {
"options": {
"type": "object",
"properties": {
"challenge": {
"type": "string"
},
"rpId": {
"type": "string"
},
"rp": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"displayName": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName"
],
"additionalProperties": false
},
"timeout": {
"type": "integer"
},
"allowCredentials": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"transports": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"type",
"transports"
],
"additionalProperties": false
}
},
"pubKeyCredParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"alg": {
"type": "integer"
}
},
"required": [
"type",
"alg"
],
"additionalProperties": false
}
},
"excludeCredentials": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"transports": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"type",
"transports"
],
"additionalProperties": false
}
},
"authenticatorSelection": {
"type": "object",
"additionalProperties": true
},
"userVerification": {
"type": "string"
},
"attestation": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"challenge"
],
"additionalProperties": false
},
"challengeToken": {
"type": "string"
}
},
"required": [
"options",
"challengeToken"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/passkeys/register/verify
Request body
{
"type": "object",
"properties": {
"response": {
"description": "WebAuthn RegistrationResponseJSON"
},
"challengeToken": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 80,
"nullable": true
},
"client": {
"type": "object",
"properties": {
"app": {
"type": "string",
"enum": [
"desktop",
"android",
"web",
"admin",
"cli",
"other"
]
},
"version": {
"type": "string"
},
"os": {
"type": "string"
},
"device": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"challengeToken"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"verified": {
"type": "boolean"
},
"passkey": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string"
},
"lastUsedAt": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"name",
"createdAt",
"lastUsedAt"
],
"additionalProperties": false
}
},
"required": [
"verified",
"passkey"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/passkeys/login/options
Responses
200Default Response
{
"type": "object",
"properties": {
"options": {
"type": "object",
"properties": {
"challenge": {
"type": "string"
},
"rpId": {
"type": "string"
},
"rp": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"displayName": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName"
],
"additionalProperties": false
},
"timeout": {
"type": "integer"
},
"allowCredentials": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"transports": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"type",
"transports"
],
"additionalProperties": false
}
},
"pubKeyCredParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"alg": {
"type": "integer"
}
},
"required": [
"type",
"alg"
],
"additionalProperties": false
}
},
"excludeCredentials": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"transports": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"type",
"transports"
],
"additionalProperties": false
}
},
"authenticatorSelection": {
"type": "object",
"additionalProperties": true
},
"userVerification": {
"type": "string"
},
"attestation": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"challenge"
],
"additionalProperties": false
},
"challengeToken": {
"type": "string"
}
},
"required": [
"options",
"challengeToken"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/auth/passkeys/login/verify
Request body
{
"type": "object",
"properties": {
"response": {
"description": "WebAuthn AuthenticationResponseJSON"
},
"challengeToken": {
"type": "string"
},
"client": {
"type": "object",
"properties": {
"app": {
"type": "string",
"enum": [
"desktop",
"android",
"web",
"admin",
"cli",
"other"
]
},
"version": {
"type": "string"
},
"os": {
"type": "string"
},
"device": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
},
"mode": {
"type": "string",
"enum": [
"session",
"authorize"
]
},
"purpose": {
"type": "string",
"enum": [
"session",
"page"
]
}
},
"required": [
"challengeToken"
],
"additionalProperties": false
}Responses
200Default Response
{
"anyOf": [
{
"type": "object",
"properties": {
"access_token": {
"type": "string",
"minLength": 1
},
"token_type": {
"type": "string",
"enum": [
"Bearer"
]
},
"expires_in": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
},
"refresh_token": {
"type": "string",
"minLength": 1
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"username": {
"type": "string"
},
"email": {
"type": "string",
"nullable": true
},
"role": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"displayName": {
"type": "string",
"nullable": true
},
"mfaEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"minLength": 1
},
"updatedAt": {
"type": "string",
"minLength": 1
},
"passwordChangedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"lastSignedInAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"emailVerifiedAt": {
"type": "string",
"minLength": 1,
"nullable": true
},
"recoveryCodesLeft": {
"type": "integer",
"minimum": 0
},
"passkeyCount": {
"type": "integer",
"minimum": 0
},
"grammaticalGender": {
"type": "string",
"enum": [
"masculine",
"feminine",
"unspecified"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"ar"
]
},
"digits": {
"type": "string",
"enum": [
"latn",
"arab"
]
},
"notifySharingEmails": {
"type": "boolean"
}
},
"required": [
"id",
"username",
"email",
"role",
"status",
"displayName",
"mfaEnabled",
"createdAt",
"updatedAt",
"passwordChangedAt",
"lastSignedInAt",
"emailVerifiedAt",
"recoveryCodesLeft",
"grammaticalGender",
"locale",
"digits",
"notifySharingEmails"
],
"additionalProperties": false
}
},
"required": [
"access_token",
"token_type",
"expires_in",
"refresh_token",
"user"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"passkey_token": {
"type": "string"
}
},
"required": [
"passkey_token"
],
"additionalProperties": false
}
]
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/auth/passkeys
Responses
200Default Response
{
"type": "object",
"properties": {
"passkeys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string"
},
"lastUsedAt": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"name",
"createdAt",
"lastUsedAt"
],
"additionalProperties": false
}
}
},
"required": [
"passkeys"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}DELETE/api/auth/passkeys/{id}
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}plans4 operations
GET/api/plans
Responses
200Default Response
{
"type": "object",
"properties": {
"plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"free",
"pro",
"team",
"business"
]
},
"name": {
"type": "string"
},
"listed": {
"type": "boolean"
},
"priceMonthlyUsd": {
"type": "number"
},
"priceAnnualPerMonthUsd": {
"type": "number"
},
"perSeat": {
"type": "boolean"
},
"bundles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"seats": {
"type": "integer",
"enum": [
5,
10,
20,
30
]
},
"priceMonthlyUsd": {
"type": "number"
},
"priceAnnualPerMonthUsd": {
"type": "number"
}
},
"required": [
"seats",
"priceMonthlyUsd",
"priceAnnualPerMonthUsd"
],
"additionalProperties": false
}
},
"contactSales": {
"type": "boolean"
},
"entitlements": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
},
"required": [
"id",
"name",
"listed",
"priceMonthlyUsd",
"priceAnnualPerMonthUsd",
"perSeat",
"entitlements"
],
"additionalProperties": false
}
}
},
"required": [
"plans"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/plans/me
Responses
200Default Response
{
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"plan": {
"type": "string",
"enum": [
"free",
"pro",
"team",
"business"
]
},
"planName": {
"type": "string"
},
"entitlements": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"subscription": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"periodEnd": {
"type": "string",
"nullable": true
},
"lifetime": {
"type": "boolean"
}
},
"required": [
"status",
"periodEnd",
"lifetime"
],
"additionalProperties": false,
"nullable": true
},
"endedPlan": {
"type": "string",
"enum": [
"free",
"pro",
"team",
"business"
]
},
"endedAt": {
"type": "string"
},
"reward": {
"type": "object",
"properties": {
"plan": {
"type": "string",
"enum": [
"free",
"pro",
"team",
"business"
]
},
"endsAt": {
"type": "string"
}
},
"required": [
"plan",
"endsAt"
],
"additionalProperties": false
}
},
"required": [
"userId",
"plan",
"planName",
"entitlements",
"subscription"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/plans/referrals
Responses
200Default Response
{
"type": "object",
"properties": {
"verified": {
"type": "boolean"
},
"termsAcceptedAt": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"link": {
"type": "string",
"nullable": true
},
"rewardDays": {
"type": "integer"
},
"cap": {
"type": "integer"
},
"windowDays": {
"type": "integer"
},
"earnedInWindow": {
"type": "integer"
},
"joins": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hint": {
"type": "string"
},
"joinedAt": {
"type": "string"
},
"status": {
"type": "string"
},
"rewardEndsAt": {
"type": "string",
"nullable": true
}
},
"required": [
"hint",
"joinedAt",
"status",
"rewardEndsAt"
],
"additionalProperties": false
}
}
},
"required": [
"verified",
"termsAcceptedAt",
"code",
"link",
"rewardDays",
"cap",
"joins"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/plans/referrals/terms
Request body
{
"type": "object",
"properties": {
"accept": {
"type": "boolean"
}
},
"required": [
"accept"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"verified": {
"type": "boolean"
},
"termsAcceptedAt": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"link": {
"type": "string",
"nullable": true
},
"rewardDays": {
"type": "integer"
},
"cap": {
"type": "integer"
},
"windowDays": {
"type": "integer"
},
"earnedInWindow": {
"type": "integer"
},
"joins": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hint": {
"type": "string"
},
"joinedAt": {
"type": "string"
},
"status": {
"type": "string"
},
"rewardEndsAt": {
"type": "string",
"nullable": true
}
},
"required": [
"hint",
"joinedAt",
"status",
"rewardEndsAt"
],
"additionalProperties": false
}
}
},
"required": [
"verified",
"termsAcceptedAt",
"code",
"link",
"rewardDays",
"cap",
"joins"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}license11 operations
GET/api/license
Responses
200Default Response
{
"type": "object",
"properties": {
"license": {
"type": "string"
},
"plan": {
"type": "string",
"enum": [
"free",
"pro",
"team",
"business"
]
}
},
"required": [
"license"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/license/client
Request body
{
"type": "object",
"properties": {
"licenseKey": {
"type": "string"
},
"device": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"nullable": true
},
"platform": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
},
"checkIn": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"license": {
"type": "string"
},
"plan": {
"type": "string",
"enum": [
"free",
"pro",
"team",
"business"
]
},
"device": {
"type": "object",
"properties": {
"lastSeenAt": {
"type": "string"
},
"releaseAt": {
"type": "string"
},
"used": {
"type": "integer"
},
"max": {
"type": "integer"
}
},
"required": [
"lastSeenAt",
"releaseAt",
"used",
"max"
],
"additionalProperties": false
}
},
"required": [
"license",
"plan"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/license/client/release
Request body
{
"type": "object",
"properties": {
"licenseKey": {
"type": "string"
},
"deviceId": {
"type": "string"
}
},
"required": [
"deviceId"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"released": {
"type": "boolean"
}
},
"required": [
"released"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}GET/api/license/devices
Responses
200Default Response
{
"type": "object",
"properties": {
"max": {
"type": "integer"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"nullable": true
},
"platform": {
"type": "string"
},
"lastSeenAt": {
"type": "string"
},
"releaseAt": {
"type": "string"
},
"warning": {
"type": "object",
"properties": {
"step": {
"type": "integer"
},
"daysLeft": {
"type": "integer"
}
},
"required": [
"step",
"daysLeft"
],
"additionalProperties": false,
"nullable": true
}
},
"required": [
"id",
"name",
"platform",
"lastSeenAt",
"releaseAt",
"warning"
],
"additionalProperties": false
}
}
},
"required": [
"max",
"devices"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}DELETE/api/license/devices/{id}
Parameters
idpath · string · requiredResponses
200Default Response
{
"type": "object",
"properties": {
"max": {
"type": "integer"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"nullable": true
},
"platform": {
"type": "string"
},
"lastSeenAt": {
"type": "string"
},
"releaseAt": {
"type": "string"
},
"warning": {
"type": "object",
"properties": {
"step": {
"type": "integer"
},
"daysLeft": {
"type": "integer"
}
},
"required": [
"step",
"daysLeft"
],
"additionalProperties": false,
"nullable": true
}
},
"required": [
"id",
"name",
"platform",
"lastSeenAt",
"releaseAt",
"warning"
],
"additionalProperties": false
}
}
},
"required": [
"max",
"devices"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/license/server/challenge
Request body
{
"type": "object",
"properties": {
"serverId": {
"type": "string"
}
},
"required": [
"serverId"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"nonce": {
"type": "string"
},
"expiresInSeconds": {
"type": "integer"
}
},
"required": [
"nonce",
"expiresInSeconds"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/license/server
Request body
{
"type": "object",
"properties": {
"serverId": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"nonce": {
"type": "string"
},
"signature": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"check",
"activate"
]
},
"licenseKey": {
"type": "string"
},
"lang": {
"type": "string",
"enum": [
"en",
"ar"
]
}
},
"required": [
"serverId",
"publicKey",
"nonce",
"signature"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"license": {
"type": "string"
},
"plan": {
"type": "string",
"enum": [
"free",
"pro",
"team",
"business"
]
},
"state": {
"type": "string"
},
"periodEnd": {
"type": "string",
"nullable": true
},
"manageable": {
"type": "boolean"
},
"licenseKey": {
"type": "string"
}
},
"required": [
"license",
"plan",
"state"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/license/server/detach
Request body
{
"type": "object",
"properties": {
"serverId": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"nonce": {
"type": "string"
},
"signature": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"detach"
]
},
"licenseKey": {
"type": "string"
},
"lang": {
"type": "string",
"enum": [
"en",
"ar"
]
}
},
"required": [
"serverId",
"publicKey",
"nonce",
"signature"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"state": {
"type": "string"
}
},
"required": [
"state"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/license/server/resend
Request body
{
"type": "object",
"properties": {
"serverId": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"nonce": {
"type": "string"
},
"signature": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"resend"
]
},
"licenseKey": {
"type": "string"
},
"lang": {
"type": "string",
"enum": [
"en",
"ar"
]
}
},
"required": [
"serverId",
"publicKey",
"nonce",
"signature"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"sent": {
"type": "boolean"
}
},
"required": [
"sent"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/license/server/handoff
Request body
{
"type": "object",
"properties": {
"serverId": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"nonce": {
"type": "string"
},
"signature": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"handoff"
]
},
"licenseKey": {
"type": "string"
},
"lang": {
"type": "string",
"enum": [
"en",
"ar"
]
}
},
"required": [
"serverId",
"publicKey",
"nonce",
"signature"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"expiresInSeconds": {
"type": "integer"
}
},
"required": [
"url",
"expiresInSeconds"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}POST/api/license/server/portal
Request body
{
"type": "object",
"properties": {
"serverId": {
"type": "string"
},
"publicKey": {
"type": "string"
},
"nonce": {
"type": "string"
},
"signature": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"portal"
]
},
"licenseKey": {
"type": "string"
},
"lang": {
"type": "string",
"enum": [
"en",
"ar"
]
}
},
"required": [
"serverId",
"publicKey",
"nonce",
"signature"
],
"additionalProperties": false
}Responses
200Default Response
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"expiresInSeconds": {
"type": "integer"
}
},
"required": [
"url",
"expiresInSeconds"
],
"additionalProperties": false
}defaultDefault Response
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"request_id": {
"type": "string"
},
"error_description": {
"type": "string"
},
"detail": {
"description": "Error-specific detail, including Zod fieldErrors for invalid bodies"
},
"retry_after": {
"type": "integer"
}
},
"required": [
"error",
"request_id"
],
"additionalProperties": false
}