{ "openapi": "3.1.0", "info": { "title": "Quo Public API", "version": "1.0.0", "description": "API for connecting with Quo.", "contact": { "name": "Quo Support", "email": "support@quo.com", "url": "https://support.quo.com/" }, "termsOfService": "https://www.quo.com/terms" }, "paths": { "/conversations/{conversationId}/mark-as-read": { "post": { "tags": [ "Conversations" ], "summary": "Mark conversation as read", "description": "Mark a conversation as read, clearing its unread indicator without sending a message. Returns the updated conversation.", "operationId": "markConversationAsRead", "parameters": [ { "in": "path", "name": "conversationId", "required": true, "schema": { "description": "The unique identifier of the conversation to mark as read.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string" }, "example": "CN123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "assignedTo", "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "assignedTo": { "anyOf": [ { "description": "The unique identifier of the user or system user the conversation is assigned to.", "examples": [ "US123abc", "SYU123abc" ], "example": "US123abc", "anyOf": [ { "pattern": "^US(.*)$", "type": "string" }, { "pattern": "^SYU(.*)$", "type": "string" } ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string", "example": "CN123abc" }, "lastActivityAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "lastActivityId": { "anyOf": [ { "description": "The unique identifier of the most recent activity in the conversation.", "examples": [ "AC123abc" ], "pattern": "^AC(.*)$", "type": "string", "example": "AC123abc" }, { "type": "null" } ] }, "mutedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "description": "The custom name of the conversation. Will be null if no custom name is set.", "examples": [ "Chat with customer" ], "type": "string", "example": "Chat with customer" }, { "type": "null" } ] }, "participants": { "type": "array", "items": { "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "example": "+15555555555" } }, "phoneNumberId": { "description": "The unique identifier of the Quo phone number associated with the conversation.", "examples": [ "PN123abc" ], "pattern": "^PN(.*)$", "type": "string", "example": "PN123abc" }, "snoozedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/conversationId", "message": "Expected string to match '^CN(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^CN(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Conversation not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } }, "/conversations/{conversationId}/mark-as-done": { "post": { "tags": [ "Conversations" ], "summary": "Mark conversation as done", "description": "Mark a conversation as done, removing it from the inbox without sending a message. Returns the updated conversation.", "operationId": "markConversationAsDone", "parameters": [ { "in": "path", "name": "conversationId", "required": true, "schema": { "description": "The unique identifier of the conversation to mark as done.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string" }, "example": "CN123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "assignedTo", "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "assignedTo": { "anyOf": [ { "description": "The unique identifier of the user or system user the conversation is assigned to.", "examples": [ "US123abc", "SYU123abc" ], "example": "US123abc", "anyOf": [ { "pattern": "^US(.*)$", "type": "string" }, { "pattern": "^SYU(.*)$", "type": "string" } ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string", "example": "CN123abc" }, "lastActivityAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "lastActivityId": { "anyOf": [ { "description": "The unique identifier of the most recent activity in the conversation.", "examples": [ "AC123abc" ], "pattern": "^AC(.*)$", "type": "string", "example": "AC123abc" }, { "type": "null" } ] }, "mutedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "description": "The custom name of the conversation. Will be null if no custom name is set.", "examples": [ "Chat with customer" ], "type": "string", "example": "Chat with customer" }, { "type": "null" } ] }, "participants": { "type": "array", "items": { "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "example": "+15555555555" } }, "phoneNumberId": { "description": "The unique identifier of the Quo phone number associated with the conversation.", "examples": [ "PN123abc" ], "pattern": "^PN(.*)$", "type": "string", "example": "PN123abc" }, "snoozedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/conversationId", "message": "Expected string to match '^CN(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^CN(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Conversation not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } }, "/conversations/{conversationId}/mark-as-open": { "post": { "tags": [ "Conversations" ], "summary": "Mark conversation as open", "description": "Mark a conversation as open, returning it to the inbox without sending a message. Returns the updated conversation.", "operationId": "markConversationAsOpen", "parameters": [ { "in": "path", "name": "conversationId", "required": true, "schema": { "description": "The unique identifier of the conversation to mark as open.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string" }, "example": "CN123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "assignedTo", "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "assignedTo": { "anyOf": [ { "description": "The unique identifier of the user or system user the conversation is assigned to.", "examples": [ "US123abc", "SYU123abc" ], "example": "US123abc", "anyOf": [ { "pattern": "^US(.*)$", "type": "string" }, { "pattern": "^SYU(.*)$", "type": "string" } ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string", "example": "CN123abc" }, "lastActivityAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "lastActivityId": { "anyOf": [ { "description": "The unique identifier of the most recent activity in the conversation.", "examples": [ "AC123abc" ], "pattern": "^AC(.*)$", "type": "string", "example": "AC123abc" }, { "type": "null" } ] }, "mutedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "description": "The custom name of the conversation. Will be null if no custom name is set.", "examples": [ "Chat with customer" ], "type": "string", "example": "Chat with customer" }, { "type": "null" } ] }, "participants": { "type": "array", "items": { "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "example": "+15555555555" } }, "phoneNumberId": { "description": "The unique identifier of the Quo phone number associated with the conversation.", "examples": [ "PN123abc" ], "pattern": "^PN(.*)$", "type": "string", "example": "PN123abc" }, "snoozedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/conversationId", "message": "Expected string to match '^CN(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^CN(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Conversation not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } }, "/messages/{messageId}/retry": { "post": { "tags": [ "Messages" ], "summary": "Retry a failed message", "description": "Attempt to re-deliver a message that previously failed to send. Only messages with a `failed` status can be retried. Messages that have permanently failed (a `failed` status with an error code) and messages with an `undelivered` status cannot be retried.", "operationId": "retryMessage", "parameters": [ { "in": "path", "name": "messageId", "required": true, "schema": { "description": "The unique identifier of the message to retry", "examples": [ "AC123abc" ], "pattern": "^AC(.*)$", "type": "string" }, "example": "AC123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/messageId", "message": "Expected string to match '^AC(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^AC(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The user is forbidden from accessing the message", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Message not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unprocessable Entity", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The message has permanently failed and cannot be retried", "docs": "https://quo.com/docs", "title": "Unprocessable Entity", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } }, "/users": { "get": { "tags": [ "Users" ], "summary": "List users", "description": "Retrieve a paginated list of users in your Quo workspace.", "operationId": "listUsers", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "email", "firstName", "lastName", "pictureUrl", "role", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the user.", "examples": [ "US123abc" ], "pattern": "^US(.*)$", "type": "string", "example": "US123abc" }, "email": { "description": "The user's email address.", "examples": [ "johndoe@example.com" ], "format": "email", "type": "string", "example": "johndoe@example.com" }, "firstName": { "anyOf": [ { "description": "The user's first name.", "examples": [ "John" ], "type": "string", "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "description": "The user's last name.", "examples": [ "Doe" ], "type": "string", "example": "Doe" }, { "type": "null" } ] }, "pictureUrl": { "anyOf": [ { "description": "The user's picture URL.", "examples": [ "https://example.com/picture.jpg" ], "format": "uri", "type": "string", "example": "https://example.com/picture.jpg" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "owner", "admin", "member" ], "description": "The user's role in the organization.", "examples": [ "owner", "admin", "member" ], "example": "owner" }, "createdAt": { "description": "Timestamp of user creation in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "Timestamp of last user update in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" } } } }, "nextCursor": { "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/userId", "message": "Expected string to match '^US(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^US(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } }, "/users/{userId}": { "get": { "tags": [ "Users" ], "summary": "Get a user by ID", "description": "Retrieve detailed information about a specific user in your Quo workspace using the user's unique identifier.", "operationId": "getUserById", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "description": "The unique identifier of the user being retrieved.", "examples": [ "US123abc" ], "pattern": "^US(.*)$", "type": "string" }, "example": "US123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "email", "firstName", "lastName", "pictureUrl", "role", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the user.", "examples": [ "US123abc" ], "pattern": "^US(.*)$", "type": "string", "example": "US123abc" }, "email": { "description": "The user's email address.", "examples": [ "johndoe@example.com" ], "format": "email", "type": "string", "example": "johndoe@example.com" }, "firstName": { "anyOf": [ { "description": "The user's first name.", "examples": [ "John" ], "type": "string", "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "description": "The user's last name.", "examples": [ "Doe" ], "type": "string", "example": "Doe" }, { "type": "null" } ] }, "pictureUrl": { "anyOf": [ { "description": "The user's picture URL.", "examples": [ "https://example.com/picture.jpg" ], "format": "uri", "type": "string", "example": "https://example.com/picture.jpg" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "owner", "admin", "member" ], "description": "The user's role in the organization.", "examples": [ "owner", "admin", "member" ], "example": "owner" }, "createdAt": { "description": "Timestamp of user creation in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "Timestamp of last user update in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/userId", "message": "Expected string to match '^US(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^US(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User with ID US1234567890 not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } }, "components": { "schemas": {}, "securitySchemes": { "apiKey": { "in": "header", "name": "Authorization", "type": "apiKey" } } }, "servers": [ { "description": "Production server", "url": "https://api.quo.com" } ], "tags": [ { "description": "Operations related to calls", "name": "Calls" }, { "description": "Operations related to call summaries, including AI-generated summaries and Sona voice assistant summaries", "name": "Call Summaries" }, { "description": "Operations related to call transcripts, including AI-generated transcripts and Sona voice assistant transcripts", "name": "Call Transcripts" }, { "description": "Operations related to contacts", "name": "Contacts" }, { "description": "Operations related to conversations", "name": "Conversations" }, { "description": "Operations related to text messages", "name": "Messages" }, { "description": "Operations related to phone numbers", "name": "Phone Numbers" }, { "description": "Operations related to users", "name": "Users" }, { "description": "Operations related to webhooks", "name": "Webhooks" } ], "security": [ { "apiKey": [] } ] }