Returns a conversation, its participants, and recent messages.
API key requests must include an X-Profile-Id header selecting an attached profile. Required API key scope: messages:read. Also accepted: messages:all, all:read, all:all.
Wircle-generated context for AI agents. This object may be empty.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Wircle","colors":{"primary":"#101113","light":"#8E8B84","dark":"#101113"},"logo":{"light":"https://mintcdn.com/wircle/JE-vUTLltvIMpMkT/logo/light.svg?fit=max\u0026auto=format\u0026n=JE-vUTLltvIMpMkT\u0026q=85\u0026s=a299431c83e6f79fd15a60508580b69f","dark":"https://mintcdn.com/wircle/JE-vUTLltvIMpMkT/logo/dark.svg?fit=max\u0026auto=format\u0026n=JE-vUTLltvIMpMkT\u0026q=85\u0026s=1caa557e751012844eea7e2d1c13cc03"},"favicon":{"light":"https://mintcdn.com/wircle/JE-vUTLltvIMpMkT/favicon-light.svg?fit=max\u0026auto=format\u0026n=JE-vUTLltvIMpMkT\u0026q=85\u0026s=bae5764112b92244b52473e3228b30e0","dark":"https://mintcdn.com/wircle/JE-vUTLltvIMpMkT/favicon-dark.svg?fit=max\u0026auto=format\u0026n=JE-vUTLltvIMpMkT\u0026q=85\u0026s=171e425ac1514aac9dd5be255722d33c"},"navbar":{"links":[{"href":"https://x.com/wircle_social","label":"Updates"},{"href":"mailto:hello@wircle.com","label":"Support"}],"primary":{"type":"button","label":"Reserve handle","href":"https://wircle.com"}},"footer":{"socials":{"x":"https://x.com/wircle_social","linkedin":"https://www.linkedin.com/company/join-wircle"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Wircle","icon":"globe","href":"https://wircle.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wircle","hasAudioNarration":false,"actualSubdomain":"wircle","customDomains":["docs.wircle.com"],"gitSource":{"type":"gitlab","owner":"wircle","repo":"wircle","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"projectId":83706261,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a9156d6c8032fbd5d277094","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":61},{"language":"default","tag":"API resources","count":59},{"language":"default","tag":"Webhooks","count":15},{"language":"default","tag":"Posts","count":14},{"language":"default","tag":"Profiles","count":9},{"language":"default","tag":"Profile Access","count":8},{"language":"default","tag":"Events","count":6},{"language":"default","tag":"Contact Requests","count":5},{"language":"default","tag":"Conversations","count":5},{"language":"default","tag":"Guides","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/conversations/get-conversation","slug":"/api-reference/conversations/get-conversation","pageMetadata":{"title":"Get conversation","description":"Returns a conversation, its participants, and recent messages.\n\nAPI key requests must include an `X-Profile-Id` header selecting an attached profile. Required API key scope: `messages:read`. Also accepted: `messages:all`, `all:read`, `all:all`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/get-conversation","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns a conversation, its participants, and recent messages.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"API key requests must include an \", _jsx(_components.code, {\n children: \"X-Profile-Id\"\n }), \" header selecting an attached profile. Required API key scope: \", _jsx(_components.code, {\n children: \"messages:read\"\n }), \". Also accepted: \", _jsx(_components.code, {\n children: \"messages:all\"\n }), \", \", _jsx(_components.code, {\n children: \"all:read\"\n }), \", \", _jsx(_components.code, {\n children: \"all:all\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get conversation","description":"Returns a conversation, its participants, and recent messages.\n\nAPI key requests must include an `X-Profile-Id` header selecting an attached profile. Required API key scope: `messages:read`. Also accepted: `messages:all`, `all:read`, `all:all`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/get-conversation","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getConversation","summary":"Get conversation","tags":["Conversations"],"description":"Returns a conversation, its participants, and recent messages.\n\nAPI key requests must include an `X-Profile-Id` header selecting an attached profile. Required API key scope: `messages:read`. Also accepted: `messages:all`, `all:read`, `all:all`.","parameters":["ce753321-1fd8-4e4a-8501-ecd24780a012","610d264a-a70d-4e37-842b-2b1f2b380277"],"security":["89b06571-6893-47f2-9c49-9d3576ac9410"],"x-required-api-key-scope":"messages:read","x-accepted-api-key-scopes":["messages:read","messages:all","all:read","all:all"],"responses":{"200":"e2f5bc0f-fd61-42a8-a28a-3bc05b783f3c","400":"6626e627-a217-4e25-a640-778e901fd528","401":"8bc47e17-c226-43f6-b112-bfd7e1f4275a","403":"d976d308-be3d-4e03-981e-c61109d6b3ec","404":"af4cc56c-9850-4ff8-bc5a-ea16a05aab73"},"method":"get","type":"path","servers":["2916f1dc-52fa-4d9f-9ab5-a33288d57251","d66d6131-a118-4f5b-bca5-46799ec47acc"],"path":"/v1/conversations/{conversation_id}","baseUrlOptions":["https://api.wircle.com","http://localhost:4201"],"title":"Get conversation","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ce753321-1fd8-4e4a-8501-ecd24780a012":{"schema":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"in":"path","name":"conversation_id","required":true},"610d264a-a70d-4e37-842b-2b1f2b380277":{"name":"X-Profile-Id","in":"header","required":true,"description":"The workspace profile performing the request. It must be attached to the API key.","schema":{"format":"uuid","type":"string","isRequired":true,"description":"The workspace profile performing the request. It must be attached to the API key.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"e2f5bc0f-fd61-42a8-a28a-3bc05b783f3c":{"description":"Agent Response Protocol success envelope.","content":{"application/json":{"schema":{"description":"Agent Response Protocol success envelope.","type":"object","required":["ok","data","agent"],"properties":{"ok":{"description":"Whether the API request completed successfully.","type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"ok","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","required":["conversation","participants","current_participant","messages","current_actor_id","is_unread"],"properties":{"conversation":{"type":"object","required":["id","kind","title","created_by_actor_id","created_from_contact_request_id","last_message_at","last_message_preview","created_at","updated_at"],"properties":{"id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.conversation.id","typeLabel":"string\u003cuuid>"},"kind":{"oneOf":[{"type":"string","enum":["direct"],"isRequired":true,"uniqueKey":"data.conversation.kind.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["group"],"isRequired":true,"uniqueKey":"data.conversation.kind.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.conversation.kind","typeLabel":"enum\u003cstring>"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.conversation.title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.conversation.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.conversation.title","typeLabel":"string | null"},"created_by_actor_id":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.conversation.created_by_actor_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","isRequired":true,"uniqueKey":"data.conversation.created_by_actor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.conversation.created_by_actor_id","typeLabel":"string\u003cuuid> | null"},"created_from_contact_request_id":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.conversation.created_from_contact_request_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","isRequired":true,"uniqueKey":"data.conversation.created_from_contact_request_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.conversation.created_from_contact_request_id","typeLabel":"string\u003cuuid> | null"},"last_message_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.conversation.last_message_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"data.conversation.last_message_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.conversation.last_message_at","typeLabel":"string\u003cdate-time> | null"},"last_message_preview":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.conversation.last_message_preview.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.conversation.last_message_preview.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.conversation.last_message_preview","typeLabel":"string | null"},"created_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.conversation.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.conversation.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data.conversation","typeLabel":"object"},"participants":{"type":"array","items":{"type":"object","required":["id","conversation_id","actor_id","role","joined_at","left_at","actor"],"properties":{"id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"conversation_id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].conversation_id","typeLabel":"string\u003cuuid>"},"actor_id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor_id","typeLabel":"string\u003cuuid>"},"role":{"oneOf":[{"type":"string","enum":["owner"],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].role.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["member"],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].role.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"joined_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].joined_at","typeLabel":"string\u003cdate-time>"},"left_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].left_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].left_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].left_at","typeLabel":"string\u003cdate-time> | null"},"actor":{"type":"object","required":["id","type","entity_id","handle","name","legal_name_verified","active_plan","avatar_url","dark_avatar_url","created_at","updated_at"],"properties":{"id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.id","typeLabel":"string\u003cuuid>"},"type":{"oneOf":[{"type":"string","enum":["profile"],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["guest_user"],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.type.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.type","typeLabel":"enum\u003cstring>"},"entity_id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.entity_id","typeLabel":"string\u003cuuid>"},"handle":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.handle.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.handle.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.handle","typeLabel":"string | null"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.name","typeLabel":"string"},"legal_name_verified":{"type":"boolean","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.legal_name_verified","typeLabel":"boolean"},"active_plan":{"oneOf":[{"type":"string","enum":["core"],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.active_plan.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["premium"],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.active_plan.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.active_plan.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.active_plan","typeLabel":"enum\u003cstring> · enum\u003cstring> · null"},"avatar_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.avatar_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.avatar_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.avatar_url","typeLabel":"string | null"},"dark_avatar_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.dark_avatar_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.dark_avatar_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.dark_avatar_url","typeLabel":"string | null"},"created_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data.participants.items.[INDEX].actor","typeLabel":"object"}},"uniqueKey":"data.participants.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.participants","typeLabel":"object[]"},"current_participant":{"type":"object","required":["id","conversation_id","actor_id","role","joined_at","left_at","last_read_at","muted_at","archived_at","created_at","updated_at"],"properties":{"id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.current_participant.id","typeLabel":"string\u003cuuid>"},"conversation_id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.current_participant.conversation_id","typeLabel":"string\u003cuuid>"},"actor_id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.current_participant.actor_id","typeLabel":"string\u003cuuid>"},"role":{"oneOf":[{"type":"string","enum":["owner"],"isRequired":true,"uniqueKey":"data.current_participant.role.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["member"],"isRequired":true,"uniqueKey":"data.current_participant.role.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.current_participant.role","typeLabel":"enum\u003cstring>"},"joined_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.current_participant.joined_at","typeLabel":"string\u003cdate-time>"},"left_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.current_participant.left_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"data.current_participant.left_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.current_participant.left_at","typeLabel":"string\u003cdate-time> | null"},"last_read_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.current_participant.last_read_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"data.current_participant.last_read_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.current_participant.last_read_at","typeLabel":"string\u003cdate-time> | null"},"muted_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.current_participant.muted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"data.current_participant.muted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.current_participant.muted_at","typeLabel":"string\u003cdate-time> | null"},"archived_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.current_participant.archived_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"data.current_participant.archived_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.current_participant.archived_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.current_participant.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.current_participant.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data.current_participant","typeLabel":"object"},"messages":{"type":"array","items":{"type":"object","required":["id","conversation_id","sender_actor_id","kind","body","deleted_at","created_at","updated_at"],"properties":{"id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.messages.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"conversation_id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.messages.items.[INDEX].conversation_id","typeLabel":"string\u003cuuid>"},"sender_actor_id":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.messages.items.[INDEX].sender_actor_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","isRequired":true,"uniqueKey":"data.messages.items.[INDEX].sender_actor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.messages.items.[INDEX].sender_actor_id","typeLabel":"string\u003cuuid> | null"},"kind":{"oneOf":[{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"data.messages.items.[INDEX].kind.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["system"],"isRequired":true,"uniqueKey":"data.messages.items.[INDEX].kind.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.messages.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"body":{"type":"string","isRequired":true,"uniqueKey":"data.messages.items.[INDEX].body","typeLabel":"string"},"deleted_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.messages.items.[INDEX].deleted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"data.messages.items.[INDEX].deleted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.messages.items.[INDEX].deleted_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.messages.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"data.messages.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.messages","typeLabel":"object[]"},"current_actor_id":{"format":"uuid","type":"string","isRequired":true,"uniqueKey":"data.current_actor_id","typeLabel":"string\u003cuuid>"},"is_unread":{"type":"boolean","isRequired":true,"uniqueKey":"data.is_unread","typeLabel":"boolean"}},"description":"Returns a conversation, its participants, and recent messages.","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"agent":{"additionalProperties":true,"description":"Wircle-generated context for AI agents. This object may be empty.","type":"object","properties":{"hint":{"description":"Optional Wircle-generated guidance for AI agents. This value is never copied from user content.","type":"string","uniqueKey":"agent.hint","typeLabel":"string"}},"isRequired":true,"uniqueKey":"agent","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"data":{"conversation":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","kind":"direct","title":"\u003cstring>","created_by_actor_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","created_from_contact_request_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","last_message_at":"2023-11-07T05:31:56Z","last_message_preview":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"},"participants":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","conversation_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","actor_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","role":"owner","joined_at":"2023-11-07T05:31:56Z","left_at":"2023-11-07T05:31:56Z","actor":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"profile","entity_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","handle":"\u003cstring>","name":"\u003cstring>","legal_name_verified":true,"active_plan":"core","avatar_url":"\u003cstring>","dark_avatar_url":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}],"current_participant":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","conversation_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","actor_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","role":"owner","joined_at":"2023-11-07T05:31:56Z","left_at":"2023-11-07T05:31:56Z","last_read_at":"2023-11-07T05:31:56Z","muted_at":"2023-11-07T05:31:56Z","archived_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"},"messages":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","conversation_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","sender_actor_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","kind":"text","body":"\u003cstring>","deleted_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}],"current_actor_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","is_unread":true},"agent":{"hint":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6626e627-a217-4e25-a640-778e901fd528":{"description":"Agent Response Protocol error envelope.","content":{"application/json":{"schema":{"description":"Agent Response Protocol error envelope.","type":"object","required":["ok","data","agent","error_code","error_message"],"properties":{"ok":{"description":"Whether the API request completed successfully.","type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"ok","typeLabel":"enum\u003cboolean>"},"data":{"description":"The endpoint payload. Error responses always return null data.","type":"null","isRequired":true,"uniqueKey":"data","typeLabel":"null"},"agent":{"additionalProperties":true,"description":"Wircle-generated context for AI agents. This object may be empty.","type":"object","properties":{"hint":{"description":"Optional Wircle-generated guidance for AI agents. This value is never copied from user content.","type":"string","uniqueKey":"agent.hint","typeLabel":"string"}},"isRequired":true,"uniqueKey":"agent","typeLabel":"object"},"error_code":{"description":"A stable snake_case code clients can use for error handling.","type":"string","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"error_message":{"description":"A human-readable explanation of the error.","type":"string","isRequired":true,"uniqueKey":"error_message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":false,"data":null,"agent":{"hint":"\u003cstring>"},"error_code":"\u003cstring>","error_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"8bc47e17-c226-43f6-b112-bfd7e1f4275a":{"description":"Agent Response Protocol error envelope.","content":{"application/json":{"schema":{"description":"Agent Response Protocol error envelope.","type":"object","required":["ok","data","agent","error_code","error_message"],"properties":{"ok":{"description":"Whether the API request completed successfully.","type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"ok","typeLabel":"enum\u003cboolean>"},"data":{"description":"The endpoint payload. Error responses always return null data.","type":"null","isRequired":true,"uniqueKey":"data","typeLabel":"null"},"agent":{"additionalProperties":true,"description":"Wircle-generated context for AI agents. This object may be empty.","type":"object","properties":{"hint":{"description":"Optional Wircle-generated guidance for AI agents. This value is never copied from user content.","type":"string","uniqueKey":"agent.hint","typeLabel":"string"}},"isRequired":true,"uniqueKey":"agent","typeLabel":"object"},"error_code":{"description":"A stable snake_case code clients can use for error handling.","type":"string","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"error_message":{"description":"A human-readable explanation of the error.","type":"string","isRequired":true,"uniqueKey":"error_message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":false,"data":null,"agent":{"hint":"\u003cstring>"},"error_code":"\u003cstring>","error_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d976d308-be3d-4e03-981e-c61109d6b3ec":{"description":"Agent Response Protocol error envelope.","content":{"application/json":{"schema":{"description":"Agent Response Protocol error envelope.","type":"object","required":["ok","data","agent","error_code","error_message"],"properties":{"ok":{"description":"Whether the API request completed successfully.","type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"ok","typeLabel":"enum\u003cboolean>"},"data":{"description":"The endpoint payload. Error responses always return null data.","type":"null","isRequired":true,"uniqueKey":"data","typeLabel":"null"},"agent":{"additionalProperties":true,"description":"Wircle-generated context for AI agents. This object may be empty.","type":"object","properties":{"hint":{"description":"Optional Wircle-generated guidance for AI agents. This value is never copied from user content.","type":"string","uniqueKey":"agent.hint","typeLabel":"string"}},"isRequired":true,"uniqueKey":"agent","typeLabel":"object"},"error_code":{"description":"A stable snake_case code clients can use for error handling.","type":"string","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"error_message":{"description":"A human-readable explanation of the error.","type":"string","isRequired":true,"uniqueKey":"error_message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":false,"data":null,"agent":{"hint":"\u003cstring>"},"error_code":"\u003cstring>","error_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"af4cc56c-9850-4ff8-bc5a-ea16a05aab73":{"description":"Agent Response Protocol error envelope.","content":{"application/json":{"schema":{"description":"Agent Response Protocol error envelope.","type":"object","required":["ok","data","agent","error_code","error_message"],"properties":{"ok":{"description":"Whether the API request completed successfully.","type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"ok","typeLabel":"enum\u003cboolean>"},"data":{"description":"The endpoint payload. Error responses always return null data.","type":"null","isRequired":true,"uniqueKey":"data","typeLabel":"null"},"agent":{"additionalProperties":true,"description":"Wircle-generated context for AI agents. This object may be empty.","type":"object","properties":{"hint":{"description":"Optional Wircle-generated guidance for AI agents. This value is never copied from user content.","type":"string","uniqueKey":"agent.hint","typeLabel":"string"}},"isRequired":true,"uniqueKey":"agent","typeLabel":"object"},"error_code":{"description":"A stable snake_case code clients can use for error handling.","type":"string","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"error_message":{"description":"A human-readable explanation of the error.","type":"string","isRequired":true,"uniqueKey":"error_message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":false,"data":null,"agent":{"hint":"\u003cstring>"},"error_code":"\u003cstring>","error_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"89b06571-6893-47f2-9c49-9d3576ac9410":{"apiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"Wircle API key","description":"Workspace API key created in Developer → API Keys.","scopes":[]}}},"servers":{"2916f1dc-52fa-4d9f-9ab5-a33288d57251":{"url":"https://api.wircle.com","description":"Production"},"d66d6131-a118-4f5b-bca5-46799ec47acc":{"url":"http://localhost:4201","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Wircle API key","description":"Workspace API key created in Developer → API Keys.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Workspace API key created in Developer → API Keys.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKeyAuth","name":"Authorization"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"wircle","siteName":"Wircle","title":"Get conversation - Wircle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-28T09:37:34.639Z","originalFileLocation":"api-reference/conversations/get-conversation.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a conversation, its participants, and recent messages. API key requests must include an X-Profile-Id header selecting an attached profile. Required API key scope: messages:read. Also accepted: messages:all, all:read, all:all.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wircle\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wircle/eW9QDOJhwsB8cBMv/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/wircle/eW9QDOJhwsB8cBMv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wircle/eW9QDOJhwsB8cBMv/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/wircle/eW9QDOJhwsB8cBMv/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/wircle/eW9QDOJhwsB8cBMv/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wircle/eW9QDOJhwsB8cBMv/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wircle/eW9QDOJhwsB8cBMv/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/wircle/eW9QDOJhwsB8cBMv/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/wircle/eW9QDOJhwsB8cBMv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get conversation - Wircle\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a conversation, its participants, and recent messages. API key requests must include an X-Profile-Id header selecting an attached profile. Required API key scope: messages:read. Also accepted: messages:all, all:read, all:all.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wircle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wircle.com/api-reference/conversations/get-conversation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wircle.mintlify.site/_mintlify/api/og/v2?division=Conversations\u0026amp;title=Get+conversation\u0026amp;description=Returns+a+conversation%2C+its+participants%2C+and+recent+messages.%0A%0AAPI+key+requests+must+include+an+%60X-Profile-Id%60+header+selecting+an+attached+profile.+Required+A\u0026amp;theme=69201f647830fe42137d5bce\u0026amp;signature=82e6f027dcbbf4e5a3bdc26a74c3e9872ef1863fbee65381e17c3c5a9a54c921\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get conversation - Wircle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a conversation, its participants, and recent messages. API key requests must include an X-Profile-Id header selecting an attached profile. Required API key scope: messages:read. Also accepted: messages:all, all:read, all:all.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wircle.mintlify.site/_mintlify/api/og/v2?division=Conversations\u0026amp;title=Get+conversation\u0026amp;description=Returns+a+conversation%2C+its+participants%2C+and+recent+messages.%0A%0AAPI+key+requests+must+include+an+%60X-Profile-Id%60+header+selecting+an+attached+profile.+Required+A\u0026amp;theme=69201f647830fe42137d5bce\u0026amp;signature=82e6f027dcbbf4e5a3bdc26a74c3e9872ef1863fbee65381e17c3c5a9a54c921\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/wircle/eW9QDOJhwsB8cBMv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wircle\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#101113\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wircle.com/api-reference/conversations/get-conversation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/conversations/get-conversation.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.wircle.com/#organization\",\"name\":\"Wircle\",\"url\":\"https://docs.wircle.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wircle/JE-vUTLltvIMpMkT/logo/light.svg?fit=max\u0026auto=format\u0026n=JE-vUTLltvIMpMkT\u0026q=85\u0026s=a299431c83e6f79fd15a60508580b69f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wircle.com#website\",\"name\":\"Wircle\",\"url\":\"https://docs.wircle.com\",\"publisher\":{\"@id\":\"https://docs.wircle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wircle.com/api-reference/conversations/get-conversation#webpage\",\"url\":\"https://docs.wircle.com/api-reference/conversations/get-conversation\",\"name\":\"Get conversation\",\"description\":\"Returns a conversation, its participants, and recent messages. API key requests must include an X-Profile-Id header selecting an attached profile. Required API key scope: messages:read. Also accepted: messages:all, all:read, all:all.\",\"dateModified\":\"2026-08-28T09:37:34.639Z\",\"isPartOf\":{\"@id\":\"https://docs.wircle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wircle.com/api-reference/conversations/get-conversation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wircle.com/api-reference/conversations/get-conversation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API resources\",\"item\":\"https://docs.wircle.com/api-reference/api-keys/list-workspace-api-keys\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Conversations\",\"item\":\"https://docs.wircle.com/api-reference/conversations/list-conversations\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get conversation\",\"item\":\"https://docs.wircle.com/api-reference/conversations/get-conversation\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.wircle.com/api-reference/conversations/get-conversation#apireference\",\"headline\":\"Get conversation\",\"name\":\"Get conversation\",\"description\":\"Returns a conversation, its participants, and recent messages. API key requests must include an X-Profile-Id header selecting an attached profile. Required API key scope: messages:read. Also accepted: messages:all, all:read, all:all.\",\"url\":\"https://docs.wircle.com/api-reference/conversations/get-conversation\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wircle.com/api-reference/conversations/get-conversation#webpage\"},\"dateModified\":\"2026-08-28T09:37:34.639Z\",\"publisher\":{\"@id\":\"https://docs.wircle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wircle.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wircle\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Wircle","nav":{"global":{"anchors":[{"anchor":"Wircle","icon":"globe","href":"https://wircle.com"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api-reference/get-started"},{"title":"Authentication and scopes","href":"/api-reference/authentication"}]},{"group":"API resources","pages":[{"group":"API Keys","pages":[{"title":"List workspace API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workspaces/{workspace_id}/api-keys","href":"/api-reference/api-keys/list-workspace-api-keys"},{"title":"Create a workspace API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspaces/{workspace_id}/api-keys","href":"/api-reference/api-keys/create-a-workspace-api-key"},{"title":"Revoke a workspace API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/workspaces/{workspace_id}/api-keys/{api_key_id}","href":"/api-reference/api-keys/revoke-a-workspace-api-key"}]},{"group":"Contact Requests","pages":[{"title":"List contact requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contact-requests","href":"/api-reference/contact-requests/list-contact-requests"},{"title":"Create contact request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contact-requests","href":"/api-reference/contact-requests/create-contact-request"},{"title":"Get contact request summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contact-requests/summary","href":"/api-reference/contact-requests/get-contact-request-summary"},{"title":"Get contact request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contact-requests/{contact_request_id}","href":"/api-reference/contact-requests/get-contact-request"},{"title":"Respond to contact request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contact-requests/{contact_request_id}/respond","href":"/api-reference/contact-requests/respond-to-contact-request"}]},{"group":"Contacts","pages":[{"title":"Get contact relationship status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/status/{profile_id}","href":"/api-reference/contacts/get-contact-relationship-status"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get conversation summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/summary","href":"/api-reference/conversations/get-conversation-summary"},{"title":"Open direct conversation","description":"Creates or returns a direct conversation with a profile.\n\nAPI key requests must include an `X-Profile-Id` header selecting an attached profile. Required API key scope: `messages:write`. Also accepted: `messages:all`, `all:write`, `all:all`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/direct","href":"/api-reference/conversations/open-direct-conversation"},{"title":"Get conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/get-conversation"},{"title":"Create conversation message","description":"Sends a message in a conversation.\n\nAPI key requests must include an `X-Profile-Id` header selecting an attached profile. Required API key scope: `messages:write`. Also accepted: `messages:all`, `all:write`, `all:all`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/messages","href":"/api-reference/conversations/create-conversation-message"}]},{"group":"Taxonomies","pages":[{"title":"List countries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/taxonomies/locations/countries","href":"/api-reference/taxonomies/list-countries"},{"title":"List states","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/taxonomies/locations/states","href":"/api-reference/taxonomies/list-states"},{"title":"List cities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/taxonomies/locations/cities","href":"/api-reference/taxonomies/list-cities"},{"title":"List occupation options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/taxonomies/profile-options/occupations","href":"/api-reference/taxonomies/list-occupation-options"}]},{"group":"OAuth","pages":[{"title":"List OAuth-authorized profiles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/oauth/authorized-profiles","href":"/api-reference/oauth/list-oauth-authorized-profiles"}]},{"group":"Profile Follows","pages":[{"title":"Follow a profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/profile-follows","href":"/api-reference/profile-follows/follow-a-profile"},{"title":"Unfollow a profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/profile-follows","href":"/api-reference/profile-follows/unfollow-a-profile"},{"title":"Get profile follow summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/profiles/{handle}/follow-summary","href":"/api-reference/profile-follows/get-profile-follow-summary"}]},{"group":"Profile Access","pages":[{"title":"List profile access","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/profiles/{profile_id}/access","href":"/api-reference/profile-access/list-profile-access"},{"title":"Invite a profile manager","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/profiles/{profile_id}/access","href":"/api-reference/profile-access/invite-a-profile-manager"},{"title":"Revoke profile access","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/profile-access/{grant_id}","href":"/api-reference/profile-access/revoke-profile-access"},{"title":"Update profile access","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/profile-access/{grant_id}","href":"/api-reference/profile-access/update-profile-access"},{"title":"Resend profile access invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/profile-access/{grant_id}/resend","href":"/api-reference/profile-access/resend-profile-access-invitation"},{"title":"List profile access invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/profile-access/invitations","href":"/api-reference/profile-access/list-profile-access-invitations"},{"title":"Get profile access invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/profile-access/invitations/{grant_id}","href":"/api-reference/profile-access/get-profile-access-invitation"},{"title":"Respond to profile access invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/profile-access/invitations/{grant_id}/respond","href":"/api-reference/profile-access/respond-to-profile-access-invitation"}]},{"group":"Profiles","pages":[{"title":"Search profiles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/profiles","href":"/api-reference/profiles/search-profiles"},{"title":"Create a profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/profiles","href":"/api-reference/profiles/create-a-profile"},{"title":"List public profiles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/profiles/directory","href":"/api-reference/profiles/list-public-profiles"},{"title":"List featured profiles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/profiles/featured","href":"/api-reference/profiles/list-featured-profiles"},{"title":"List profiles for the public sitemap","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/profiles/sitemap","href":"/api-reference/profiles/list-profiles-for-the-public-sitemap"},{"title":"List signup follow suggestions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/profiles/signup-autofollow","href":"/api-reference/profiles/list-signup-follow-suggestions"},{"title":"Get a profile by handle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/profiles/{handle}","href":"/api-reference/profiles/get-a-profile-by-handle"},{"title":"Update a profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/profiles/{profile_id}","href":"/api-reference/profiles/update-a-profile"},{"title":"Upload profile media","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/profiles/{profile_id}/media/{kind}/{theme}","href":"/api-reference/profiles/upload-profile-media"}]},{"group":"Posts","pages":[{"title":"Get Golden Ticket eligibility","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/posts/golden-ticket-eligibility","href":"/api-reference/posts/get-golden-ticket-eligibility"},{"title":"Create a post","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/posts","href":"/api-reference/posts/create-a-post"},{"title":"Create a post with images","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/posts/with-images","href":"/api-reference/posts/create-a-post-with-images"},{"title":"Set a post reaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/posts/{post_id}/reaction","href":"/api-reference/posts/set-a-post-reaction"},{"title":"List post comments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/posts/{post_id}/comments","href":"/api-reference/posts/list-post-comments"},{"title":"Create a comment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/posts/{post_id}/comments","href":"/api-reference/posts/create-a-comment"},{"title":"Create a comment with images","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/posts/{post_id}/comments/with-images","href":"/api-reference/posts/create-a-comment-with-images"},{"title":"Set a comment reaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/comments/{comment_id}/reaction","href":"/api-reference/posts/set-a-comment-reaction"},{"title":"List feed posts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/posts/feed","href":"/api-reference/posts/list-feed-posts"},{"title":"Get the post sitemap manifest","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/posts/sitemap-manifest","href":"/api-reference/posts/get-the-post-sitemap-manifest"},{"title":"List a page of posts for the public sitemap","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/posts/sitemap/{page}","href":"/api-reference/posts/list-a-page-of-posts-for-the-public-sitemap"},{"title":"Get a post","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/posts/{post_id}","href":"/api-reference/posts/get-a-post"},{"title":"Remove a post","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/posts/{post_id}","href":"/api-reference/posts/remove-a-post"},{"title":"List profile posts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/profiles/{handle}/posts","href":"/api-reference/posts/list-profile-posts"}]},{"group":"Webhooks","pages":[{"title":"List workspace webhook delivery activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workspaces/{workspace_id}/webhook-deliveries","href":"/api-reference/webhooks/list-workspace-webhook-delivery-activity"},{"title":"List workspace webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workspaces/{workspace_id}/webhook-endpoints","href":"/api-reference/webhooks/list-workspace-webhook-endpoints"},{"title":"Create a workspace webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workspaces/{workspace_id}/webhook-endpoints","href":"/api-reference/webhooks/create-a-workspace-webhook-endpoint"},{"title":"Revoke a workspace webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/workspaces/{workspace_id}/webhook-endpoints/{webhook_endpoint_id}","href":"/api-reference/webhooks/revoke-a-workspace-webhook-endpoint"},{"title":"Update a workspace webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/workspaces/{workspace_id}/webhook-endpoints/{webhook_endpoint_id}","href":"/api-reference/webhooks/update-a-workspace-webhook-endpoint"}]}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/api-reference/webhooks"}]}]},"basePath":"","title":"Get conversation - Wircle","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}