--- updatedAt: 2026-04-28T15:27:08.000Z agentTools: projectIndex: https://developer.unipile.com/llms.txt --- # List all messages from a chat Returns a list of messages related to the given chat. Some parameters are available to filter the results. # OpenAPI definition ```json { "openapi": "3.0.0", "paths": { "/api/v1/chats/{chat_id}/messages": { "get": { "operationId": "ChatsController_listChatMessages", "x-readme": { "code-samples": [ { "language": "node", "code": "import { UnipileClient } from \"unipile-node-sdk\"\n\n// SDK setup\nconst BASE_URL = \"your base url\"\nconst ACCESS_TOKEN = \"your access token\"\n// Inputs\nconst chat_id = \"chat id\"\n\ntry {\n\tconst client = new UnipileClient(BASE_URL, ACCESS_TOKEN)\n\n\tconst response = await client.messaging.getAllMessagesFromChat({\n\t\tchat_id,\n\t})\n} catch (error) {\n\tconsole.log(error)\n}\n", "name": "unipile-node-sdk", "install": "npm install unipile-node-sdk" } ] }, "summary": "List all messages from a chat", "description": "Returns a list of messages related to the given chat. Some parameters are available to filter the results.", "parameters": [ { "name": "cursor", "required": false, "in": "query", "schema": { "title": "CursorParam", "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.", "minLength": 1, "type": "string" } }, { "name": "before", "required": false, "in": "query", "schema": { "description": "A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).", "example": "2025-12-31T23:59:59.999Z", "pattern": "^[1-2]\\d{3}-[0-1]\\d-[0-3]\\dT\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", "type": "string" } }, { "name": "after", "required": false, "in": "query", "schema": { "description": "A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).", "example": "2025-12-31T23:59:59.999Z", "pattern": "^[1-2]\\d{3}-[0-1]\\d-[0-3]\\dT\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "minimum": 1, "maximum": 250, "description": "A limit for the number of items returned in the response. The value can be set between 1 and 250.", "example": 100, "type": "integer" } }, { "name": "sender_id", "required": false, "in": "query", "description": "A filter to target messages received from a certain sender. The id of the sender targeted.", "schema": { "type": "string" } }, { "name": "chat_id", "required": true, "in": "path", "description": "The id of the chat related to requested messages.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Request succeeded.", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "MessageList" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "Message" ] }, "message_id": { "title": "UniqueId", "description": "A unique identifier.", "minLength": 1, "type": "string" }, "provider_id": { "type": "string" }, "sender_id": { "type": "string" }, "text": { "anyOf": [ { "type": "string" }, { "nullable": true } ] }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "img" ] }, "size": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "width", "height" ] }, "sticker": { "type": "boolean" } }, "required": [ "id", "unavailable", "type", "size", "sticker" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "video" ] }, "size": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "width", "height" ] }, "gif": { "type": "boolean" } }, "required": [ "id", "unavailable", "type", "size", "gif" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "audio" ] }, "duration": { "type": "number" }, "voice_note": { "type": "boolean" } }, "required": [ "id", "unavailable", "type", "voice_note" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "file" ] }, "file_name": { "type": "string" } }, "required": [ "id", "unavailable", "type", "file_name" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "linkedin_post" ] } }, "required": [ "id", "unavailable", "type" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "video_meeting" ] }, "starts_at": { "anyOf": [ { "type": "number" }, { "nullable": true } ] }, "expires_at": { "anyOf": [ { "type": "number" }, { "nullable": true } ] }, "time_range": { "anyOf": [ { "type": "number" }, { "nullable": true } ] } }, "required": [ "id", "unavailable", "type", "starts_at", "expires_at", "time_range" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "media_share" ] }, "post": { "type": "object", "properties": { "url": { "type": "string" }, "author": { "type": "string" }, "author_id": { "type": "string" }, "author_messaging_id": { "type": "string" }, "description": { "type": "string" } }, "required": [ "url" ] }, "story": { "type": "object", "properties": { "url": { "type": "string" }, "author": { "type": "string" } }, "required": [ "url" ] }, "cta": { "type": "object", "properties": { "text": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text", "type" ] }, "link": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "image_url": { "type": "string" } }, "required": [ "text", "url", "title", "summary", "image_url" ] }, "video_call": { "type": "object", "properties": { "type": { "type": "string" }, "description": { "type": "string" }, "duration": { "type": "number" }, "start_time": { "type": "number" }, "end_time": { "type": "number" } }, "required": [ "type", "description", "duration", "start_time", "end_time" ] } }, "required": [ "id", "unavailable", "type" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "profile" ] }, "profile": { "type": "object", "properties": { "id": { "type": "string" }, "profile_pic_url": { "type": "string" }, "is_verified": { "type": "boolean" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "is_private": { "type": "boolean" }, "instagram_messaging_id": { "type": "string" } }, "required": [ "id", "profile_pic_url", "is_verified", "username", "full_name", "is_private" ] } }, "required": [ "id", "unavailable", "type", "profile" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "contact_card" ] }, "display_name": { "anyOf": [ { "type": "string" }, { "nullable": true } ] }, "phones": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "string" }, "type": { "type": "string" } }, "required": [ "number" ] } }, "emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "type": { "type": "string" } }, "required": [ "address" ] } }, "organization": { "anyOf": [ { "type": "string" }, { "nullable": true } ] } }, "required": [ "id", "unavailable", "type", "display_name", "phones", "emails", "organization" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "poll" ] }, "poll": { "type": "object", "properties": { "question": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "voter_count": { "type": "number" } }, "required": [ "text", "voter_count" ] } }, "description": { "anyOf": [ { "type": "string" }, { "nullable": true } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "regular" ] }, { "type": "string", "enum": [ "quiz" ] } ] }, "is_anonymous": { "type": "boolean" }, "allows_multiple_answers": { "type": "boolean" } }, "required": [ "question", "options", "description", "type", "is_anonymous", "allows_multiple_answers" ] } }, "required": [ "id", "unavailable", "type", "poll" ] } ] } }, "id": { "title": "UniqueId", "description": "A unique identifier.", "minLength": 1, "type": "string" }, "account_id": { "title": "UniqueId", "description": "A unique identifier.", "minLength": 1, "type": "string" }, "chat_id": { "title": "UniqueId", "description": "A unique identifier.", "minLength": 1, "type": "string" }, "chat_provider_id": { "type": "string" }, "timestamp": { "type": "string" }, "is_sender": { "anyOf": [ { "type": "number", "enum": [ 0 ] }, { "type": "number", "enum": [ 1 ] } ] }, "quoted": { "type": "object", "properties": { "message_id": { "title": "UniqueId", "description": "A unique identifier.", "minLength": 1, "type": "string" }, "provider_id": { "type": "string" }, "sender_id": { "type": "string" }, "text": { "anyOf": [ { "type": "string" }, { "nullable": true } ] }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "img" ] }, "size": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "width", "height" ] }, "sticker": { "type": "boolean" } }, "required": [ "id", "unavailable", "type", "size", "sticker" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "video" ] }, "size": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "width", "height" ] }, "gif": { "type": "boolean" } }, "required": [ "id", "unavailable", "type", "size", "gif" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "audio" ] }, "duration": { "type": "number" }, "voice_note": { "type": "boolean" } }, "required": [ "id", "unavailable", "type", "voice_note" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "file" ] }, "file_name": { "type": "string" } }, "required": [ "id", "unavailable", "type", "file_name" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "linkedin_post" ] } }, "required": [ "id", "unavailable", "type" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "video_meeting" ] }, "starts_at": { "anyOf": [ { "type": "number" }, { "nullable": true } ] }, "expires_at": { "anyOf": [ { "type": "number" }, { "nullable": true } ] }, "time_range": { "anyOf": [ { "type": "number" }, { "nullable": true } ] } }, "required": [ "id", "unavailable", "type", "starts_at", "expires_at", "time_range" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "media_share" ] }, "post": { "type": "object", "properties": { "url": { "type": "string" }, "author": { "type": "string" }, "author_id": { "type": "string" }, "author_messaging_id": { "type": "string" }, "description": { "type": "string" } }, "required": [ "url" ] }, "story": { "type": "object", "properties": { "url": { "type": "string" }, "author": { "type": "string" } }, "required": [ "url" ] }, "cta": { "type": "object", "properties": { "text": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text", "type" ] }, "link": { "type": "object", "properties": { "text": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "image_url": { "type": "string" } }, "required": [ "text", "url", "title", "summary", "image_url" ] }, "video_call": { "type": "object", "properties": { "type": { "type": "string" }, "description": { "type": "string" }, "duration": { "type": "number" }, "start_time": { "type": "number" }, "end_time": { "type": "number" } }, "required": [ "type", "description", "duration", "start_time", "end_time" ] } }, "required": [ "id", "unavailable", "type" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "profile" ] }, "profile": { "type": "object", "properties": { "id": { "type": "string" }, "profile_pic_url": { "type": "string" }, "is_verified": { "type": "boolean" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "is_private": { "type": "boolean" }, "instagram_messaging_id": { "type": "string" } }, "required": [ "id", "profile_pic_url", "is_verified", "username", "full_name", "is_private" ] } }, "required": [ "id", "unavailable", "type", "profile" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "contact_card" ] }, "display_name": { "anyOf": [ { "type": "string" }, { "nullable": true } ] }, "phones": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "string" }, "type": { "type": "string" } }, "required": [ "number" ] } }, "emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "type": { "type": "string" } }, "required": [ "address" ] } }, "organization": { "anyOf": [ { "type": "string" }, { "nullable": true } ] } }, "required": [ "id", "unavailable", "type", "display_name", "phones", "emails", "organization" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "file_size": { "type": "number" }, "unavailable": { "type": "boolean" }, "mimetype": { "type": "string" }, "url": { "type": "string" }, "url_expires_at": { "type": "number" }, "type": { "type": "string", "enum": [ "poll" ] }, "poll": { "type": "object", "properties": { "question": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "voter_count": { "type": "number" } }, "required": [ "text", "voter_count" ] } }, "description": { "anyOf": [ { "type": "string" }, { "nullable": true } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "regular" ] }, { "type": "string", "enum": [ "quiz" ] } ] }, "is_anonymous": { "type": "boolean" }, "allows_multiple_answers": { "type": "boolean" } }, "required": [ "question", "options", "description", "type", "is_anonymous", "allows_multiple_answers" ] } }, "required": [ "id", "unavailable", "type", "poll" ] } ] } } }, "required": [ "provider_id", "sender_id", "text", "attachments" ] }, "is_forwarded": { "type": "boolean" }, "is_view_once": { "type": "boolean" }, "reactions": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "sender_id": { "type": "string" }, "is_sender": { "type": "boolean" } }, "required": [ "value", "sender_id", "is_sender" ] } }, "mentions": { "type": "object", "x-patternProperties": { "^(.*)$": { "type": "string" } }, "additionalProperties": true }, "seen": { "anyOf": [ { "type": "number", "enum": [ 0 ] }, { "type": "number", "enum": [ 1 ] } ] }, "seen_by": { "type": "object", "x-patternProperties": { "^(.*)$": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] } }, "additionalProperties": true }, "hidden": { "anyOf": [ { "type": "number", "enum": [ 0 ] }, { "type": "number", "enum": [ 1 ] } ] }, "deleted": { "anyOf": [ { "type": "number", "enum": [ 0 ] }, { "type": "number", "enum": [ 1 ] } ] }, "deleted_for": { "anyOf": [ { "type": "string", "enum": [ "me" ] }, { "type": "string", "enum": [ "everyone" ] } ] }, "edited": { "anyOf": [ { "type": "number", "enum": [ 0 ] }, { "type": "number", "enum": [ 1 ] } ] }, "is_event": { "anyOf": [ { "type": "number", "enum": [ 0 ] }, { "type": "number", "enum": [ 1 ] } ] }, "delivered": { "anyOf": [ { "type": "number", "enum": [ 0 ] }, { "type": "number", "enum": [ 1 ] } ] }, "behavior": { "anyOf": [ { "type": "number", "enum": [ 0 ] }, { "nullable": true } ] }, "event_type": { "anyOf": [ { "type": "number", "enum": [ 0 ] }, { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] }, { "type": "number", "enum": [ 6 ] }, { "type": "number", "enum": [ 7 ] }, { "type": "number", "enum": [ 8 ] }, { "type": "number", "enum": [ 9 ] }, { "type": "number", "enum": [ 10 ] }, { "type": "number", "enum": [ 11 ] }, { "type": "number", "enum": [ 12 ] }, { "type": "number", "enum": [ 13 ] }, { "type": "number", "enum": [ 14 ] } ] }, "original": { "type": "string" }, "replies": { "type": "number" }, "reply_by": { "type": "array", "items": { "type": "string" } }, "parent": { "title": "UniqueId", "description": "A unique identifier.", "minLength": 1, "type": "string" }, "sender_attendee_id": { "title": "UniqueId", "description": "A unique identifier.", "minLength": 1, "type": "string" }, "subject": { "anyOf": [ { "type": "string" }, { "nullable": true } ] }, "message_type": { "anyOf": [ { "type": "string", "enum": [ "MESSAGE" ] }, { "type": "string", "enum": [ "INVITATION" ] }, { "type": "string", "enum": [ "INMAIL" ] }, { "type": "string", "enum": [ "INMAIL_DECLINE" ] }, { "type": "string", "enum": [ "INMAIL_REPLY" ] }, { "type": "string", "enum": [ "INMAIL_ACCEPT" ] }, { "type": "string", "enum": [ "STORY_MENTION" ] }, { "type": "string", "enum": [ "STORY_REPLY" ] }, { "type": "string", "enum": [ "CONTACT" ] } ] }, "attendee_type": { "anyOf": [ { "type": "string", "enum": [ "MEMBER" ] }, { "type": "string", "enum": [ "ORGANIZATION" ] }, { "type": "string", "enum": [ "OTHER" ] } ] }, "attendee_distance": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ -1 ] } ] }, "sender_urn": { "type": "string" }, "reply_to": { "type": "object", "properties": { "id": { "title": "UniqueId", "description": "A unique identifier.", "minLength": 1, "type": "string" }, "provider_id": { "type": "string" }, "timestamp": { "type": "string" }, "sender_attendee_id": { "title": "UniqueId", "description": "A unique identifier.", "minLength": 1, "type": "string" }, "sender_id": { "type": "string" }, "text": { "anyOf": [ { "type": "string" }, { "nullable": true } ] } }, "required": [ "id", "provider_id", "timestamp", "sender_attendee_id", "sender_id", "text" ] } }, "required": [ "object", "provider_id", "sender_id", "text", "attachments", "id", "account_id", "chat_id", "chat_provider_id", "timestamp", "is_sender", "reactions", "seen", "seen_by", "hidden", "deleted", "edited", "is_event", "delivered", "behavior", "original", "sender_attendee_id" ] } }, "cursor": { "anyOf": [ {}, { "nullable": true } ] } }, "required": [ "object", "items", "cursor" ] } } } }, "401": { "description": "## Unauthorized\n\n### Missing credentials - Type: \"errors/missing_credentials\"\nSome credentials are necessary to perform the request.\n\n### Multiple sessions - Type: \"errors/multiple_sessions\"\nLinkedIn limits the use of multiple sessions on certain Recruiter accounts. This error restricts access to this route only, but causing a popup to appear in the user's browser, prompting them to choose a session, which can disconnect the current account. To avoid this error, use the cookie connection method.\n\n### Wrong account - Type: \"errors/wrong_account\"\nThe provided credentials do not match the correct account.\n\n### Invalid credentials - Type: \"errors/invalid_credentials\"\nThe provided credentials are invalid.\n\n### Invalid proxy credentials - Type: \"errors/invalid_proxy_credentials\"\nThe provided proxy credentials are invalid.\n\n### Invalid IMAP configuration - Type: \"errors/invalid_imap_configuration\"\nThe provided IMAP configuration is invalid.\n\n### Invalid SMTP configuration - Type: \"errors/invalid_smtp_configuration\"\nThe provided SMTP configuration is invalid.\n\n### Invalid checkpoint solution - Type: \"errors/invalid_checkpoint_solution\"\nThe checkpoint resolution did not pass successfully. Please retry.\n\n### Checkpoint error - Type: \"errors/checkpoint_error\"\nThe checkpoint does not appear to be resolvable. Please try again and contact support if the problem persists.\n\n### Expired credentials - Type: \"errors/expired_credentials\"\nInvalid credentials. Please check your username and password and try again.\n\n### Expired link - Type: \"errors/expired_link\"\nThis link has expired. Please return to the application and generate a new one.\n\n### Insufficient privileges - Type: \"errors/insufficient_privileges\"\nThis resource seems to be out of your scopes.\n\n### Disconnected account - Type: \"errors/disconnected_account\"\nThe account appears to be disconnected from the provider service.\n\n### Disconnected feature - Type: \"errors/disconnected_feature\"\nThe service you're trying to reach appears to be disconnected.", "content": { "application/json": { "schema": { "title": "UnauthorizedResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/missing_credentials", "errors/multiple_sessions", "errors/invalid_checkpoint_solution", "errors/invalid_proxy_credentials", "errors/checkpoint_error", "errors/invalid_credentials", "errors/expired_credentials", "errors/insufficient_privileges", "errors/disconnected_account", "errors/disconnected_feature", "errors/invalid_credentials_but_valid_account_imap", "errors/expired_link", "errors/wrong_account" ] }, "status": { "type": "number", "enum": [ 401 ] }, "connectionParams": { "type": "object", "properties": { "imap_host": { "type": "string" }, "imap_encryption": { "type": "string" }, "imap_port": { "type": "number" }, "imap_user": { "type": "string" }, "smtp_host": { "type": "string" }, "smtp_port": { "type": "number" }, "smtp_user": { "type": "string" } }, "required": [ "imap_host", "imap_port", "imap_user", "smtp_host", "smtp_port", "smtp_user" ] } }, "required": [ "title", "type", "status" ] } } } }, "403": { "description": "## Forbidden\n\n### Insufficient permissions - Type: \"errors/insufficient_permissions\"\nValid authentication but insufficient permissions to perform the request.\n\n### Account restricted - Type: \"errors/account_restricted\"\nAccess to this account has been restricted. Please sign in to the provider service to learn more about how to unlock your account.\n\n### Account mismatch - Type: \"errors/account_mismatch\"\nThis action cannot be done with your account.\n\n### Unknown authentication context - Type: \"errors/unknown_authentication_context\"\nAn additional step seems necessary to complete login. Please connect to provider with your browser to find out more, then retry authentication.\n\n### Session mismatch - Type: \"errors/session_mismatch\"\nToken User id does not match client session id.\n\n### Feature not subscribed - Type: \"errors/feature_not_subscribed\"\nThe requested feature has either not been subscribed or not been authenticated properly.\n\n### Subscription required - Type: \"errors/subscription_required\"\nThe action you're trying to achieve requires a subscription to provider's services.\n\n### Resource access restricted - Type: \"errors/resource_access_restricted\"\nYou don't have access to this resource.\n\n### Action required - Type: \"errors/action_required\"\nAn additional step seems necessary. Complete authentication on the provider's native application and try again.", "content": { "application/json": { "schema": { "title": "ForbiddenResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/account_restricted", "errors/account_mismatch", "errors/insufficient_permissions", "errors/session_mismatch", "errors/feature_not_subscribed", "errors/subscription_required", "errors/unknown_authentication_context", "errors/action_required", "errors/resource_access_restricted" ] }, "status": { "type": "number", "enum": [ 403 ] } }, "required": [ "title", "type", "status" ] } } } }, "404": { "description": "\n## Not Found\n### Resource not found.\nThe requested resource were not found.\nChat not found", "content": { "application/json": { "schema": { "title": "NotFoundResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/resource_not_found", "errors/invalid_resource_identifier" ] }, "status": { "type": "number", "enum": [ 404 ] } }, "required": [ "title", "type", "status" ] } } } }, "500": { "description": "## Internal Server Error\n\n### Unexpected error - Type: \"errors/unexpected_error\"\nSomething went wrong. {{moreDetails}}\n\n### Provider error - Type: \"errors/provider_error\"\nThe provider is experiencing operational problems. Please try again later.\n\n### Authentication intent error - Type: \"errors/authentication_intent_error\"\nThe current authentication intent was killed after failure. Please start the process again from the beginning.", "content": { "application/json": { "schema": { "title": "InternalServerErrorResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/unexpected_error", "errors/provider_error", "errors/authentication_intent_error" ] }, "status": { "type": "number", "enum": [ 500 ] } }, "required": [ "title", "type", "status" ] } } } }, "503": { "description": "## Service Unavailable\n\n### No client session - Type: \"errors/no_client_session\"\nNo client session is currently running.\n\n### No channel - Type: \"errors/no_channel\"\nNo channel to client session.\n\n### Handler missing - Type: \"errors/no_handler\"\nHandler missing for that request.\n\n### Network down - Type: \"errors/network_down\"\nNetwork is down on server side. Please wait a moment and retry.\n\n### Service unavailable - Type: \"errors/service_unavailable\"\nPlease try again later.", "content": { "application/json": { "schema": { "title": "ServiceUnavailableResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/no_client_session", "errors/no_channel", "errors/no_handler", "errors/network_down", "errors/service_unavailable" ] }, "status": { "type": "number", "enum": [ 503 ] } }, "required": [ "title", "type", "status" ] } } } }, "504": { "description": "## Gateway Timeout\n\n### Request timed out - Type: \"errors/request_timeout\"\nRequest Timeout. Please try again, and if the issue persists, contact support.", "content": { "application/json": { "schema": { "title": "GatewayTimeoutResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/request_timeout" ] }, "status": { "type": "number", "enum": [ 504 ] } }, "required": [ "title", "type", "status" ] } } } } }, "tags": [ "Messaging" ], "security": [ { "Access-Token": [] } ] } } }, "info": { "title": "Unipile API Reference", "description": "Unipile Communication is an **HTTP API**. It has predictable resource-oriented `URLs`, accepts **form-encoded** or **JSON-encoded** request bodies, returns **JSON-encoded responses**, and uses standard HTTP response codes, authentication, and verbs.", "version": "1.0", "contact": {} }, "tags": [ { "name": "Messaging", "description": "Messaging management" } ], "servers": [ { "url": "https://{subdomain}.unipile.com:{port}", "description": "live server", "variables": { "subdomain": { "default": "api1" }, "port": { "default": "13111" } } }, { "url": "http://127.0.0.1:3114" } ], "components": { "securitySchemes": { "Access-Token": { "type": "apiKey", "in": "header", "name": "X-API-KEY" } } } } ```