{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Kinbox Docs","colors":{"primary":"#367fee","light":"#87abff","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/kinbox/rfT19ZB_LIv08ILX/logo/light.svg?fit=max\u0026auto=format\u0026n=rfT19ZB_LIv08ILX\u0026q=85\u0026s=fa93682e7b102a1661ad9c08e9351d06","dark":"https://mintcdn.com/kinbox/rfT19ZB_LIv08ILX/logo/dark.svg?fit=max\u0026auto=format\u0026n=rfT19ZB_LIv08ILX\u0026q=85\u0026s=9f70dd3e1d3c6ffbabac116d9b284735"},"favicon":"https://mintcdn.com/kinbox/rfT19ZB_LIv08ILX/favicon.png?fit=max\u0026auto=format\u0026n=rfT19ZB_LIv08ILX\u0026q=85\u0026s=a4f8ae78ab46d7a1c4ad02e84f8fe15f","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://platform.kinbox.com.br"}},"navbar":{"links":[{"icon":"whatsapp","href":"https://api.whatsapp.com/send?text=Oi%20preciso%20de%20ajuda\u0026phone=%2B558001151777\u0026type=phone_number\u0026app_absent=0","label":"Suporte"}],"primary":{"type":"button","label":"Abrir Kinbox","href":"https://app.kinbox.com.br"}},"footer":{"socials":{"instagram":"https://www.instagram.com/kinboxoficial","github":"https://github.com/kinboxapp"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kinbox","hasAudioNarration":false,"actualSubdomain":"kinbox","customDomains":["developer.kinbox.com.br"],"gitSource":{"type":"github","owner":"kinboxapp","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ab53751a89dca91c2bfe5fb","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API reference","count":53},{"language":"default","tag":"Campanhas","count":8},{"language":"default","tag":"Produtos","count":6},{"language":"default","tag":"Negócios","count":5},{"language":"default","tag":"Funis","count":5},{"language":"default","tag":"Tags","count":5},{"language":"default","tag":"Canais","count":4},{"language":"default","tag":"Contatos","count":4},{"language":"default","tag":"Grupos","count":4},{"language":"default","tag":"Mensagens","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/sessions/retrieve-a-session","slug":"/api-reference/sessions/retrieve-a-session","pageMetadata":{"openapi":"get /v1/sessions/{id}","title":"Retrieve a session","description":"Accepts either the session id (Mongo ObjectId) or the call id (numeric). If the id is purely numeric, the session is looked up by call.id.","href":"/api-reference/sessions/retrieve-a-session"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Accepts either the session id (Mongo ObjectId) or the call id (numeric). If the id is purely numeric, the session is looked up by call.id.\"\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":{"openapi":"get /v1/sessions/{id}","title":"Retrieve a session","description":"Accepts either the session id (Mongo ObjectId) or the call id (numeric). If the id is purely numeric, the session is looked up by call.id.","href":"/api-reference/sessions/retrieve-a-session"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Accepts either the session id (Mongo ObjectId) or the call id (numeric). If the id is purely numeric, the session is looked up by call.id.","operationId":"getSession","parameters":["f0c55b5b-8c50-45be-aa70-089548a91b03"],"responses":{"200":"fa261029-d940-43f2-9f9a-1e0742cebd85"},"summary":"Retrieve a session","tags":["v1Sessions"],"method":"get","type":"path","servers":[],"security":[],"path":"/v1/sessions/{id}","baseUrlOptions":["https://platform.kinbox.com.br"],"title":"Retrieve a session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f0c55b5b-8c50-45be-aa70-089548a91b03":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"fa261029-d940-43f2-9f9a-1e0742cebd85":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"66e2f1c9a1b2c3d4e5f60718","description":"Id da sessão (ObjectId)","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"_id":{"type":"string","example":"66e2f1c9a1b2c3d4e5f60718","isRequired":true,"uniqueKey":"_id","typeLabel":"string"},"workspaceId":{"type":"number","example":1,"isRequired":true,"uniqueKey":"workspaceId","typeLabel":"number"},"call":{"type":"object","properties":{"id":{"type":"number","example":987654,"description":"Id da sessão de atendimento (call)","isRequired":true,"uniqueKey":"call.id","typeLabel":"number"},"customerPlatformId":{"type":"number","example":1234567,"description":"Id da conversa (contato no canal). Use em GET /v1/conversations/{id}/messages.","isRequired":true,"uniqueKey":"call.customerPlatformId","typeLabel":"number"},"workspacePlatformId":{"oneOf":[{"type":"number","example":103,"description":"Id do canal","uniqueKey":"call.workspacePlatformId.oneOf.0","typeLabel":"number"},{"type":"null","example":103,"description":"Id do canal","uniqueKey":"call.workspacePlatformId.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.workspacePlatformId","typeLabel":"number | null"},"operatorId":{"oneOf":[{"type":"number","example":42,"uniqueKey":"call.operatorId.oneOf.0","typeLabel":"number"},{"type":"null","example":42,"uniqueKey":"call.operatorId.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.operatorId","typeLabel":"number | null"},"groupId":{"oneOf":[{"type":"number","example":10,"uniqueKey":"call.groupId.oneOf.0","typeLabel":"number"},{"type":"null","example":10,"uniqueKey":"call.groupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.groupId","typeLabel":"number | null"},"chatBotId":{"oneOf":[{"type":"number","uniqueKey":"call.chatBotId.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"call.chatBotId.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.chatBotId","typeLabel":"number | null"},"lastBotId":{"oneOf":[{"type":"number","uniqueKey":"call.lastBotId.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"call.lastBotId.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.lastBotId","typeLabel":"number | null"},"lastCallMessageId":{"oneOf":[{"type":"number","uniqueKey":"call.lastCallMessageId.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"call.lastCallMessageId.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.lastCallMessageId","typeLabel":"number | null"},"protocol":{"oneOf":[{"type":"string","example":"2026091412345","uniqueKey":"call.protocol.oneOf.0","typeLabel":"string"},{"type":"null","example":"2026091412345","uniqueKey":"call.protocol.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.protocol","typeLabel":"string | null"},"uniqueIdentifier":{"oneOf":[{"type":"string","uniqueKey":"call.uniqueIdentifier.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"call.uniqueIdentifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.uniqueIdentifier","typeLabel":"string | null"},"isFinished":{"type":"boolean","example":false,"uniqueKey":"call.isFinished","typeLabel":"boolean"},"isChatBotActive":{"type":"boolean","example":false,"uniqueKey":"call.isChatBotActive","typeLabel":"boolean"},"isFromIntegration":{"type":"boolean","example":false,"uniqueKey":"call.isFromIntegration","typeLabel":"boolean"},"isHidden":{"type":"boolean","example":false,"uniqueKey":"call.isHidden","typeLabel":"boolean"},"isImported":{"type":"boolean","example":false,"uniqueKey":"call.isImported","typeLabel":"boolean"},"isReopened":{"type":"boolean","example":false,"uniqueKey":"call.isReopened","typeLabel":"boolean"},"isWithoutOperatorAnswer":{"type":"boolean","example":false,"uniqueKey":"call.isWithoutOperatorAnswer","typeLabel":"boolean"},"isWithoutClientAnswer":{"type":"boolean","example":false,"uniqueKey":"call.isWithoutClientAnswer","typeLabel":"boolean"},"isCreatedByActiveChat":{"type":"boolean","example":false,"uniqueKey":"call.isCreatedByActiveChat","typeLabel":"boolean"},"isRatingActive":{"type":"boolean","example":false,"uniqueKey":"call.isRatingActive","typeLabel":"boolean"},"isNewContact":{"type":"boolean","example":false,"uniqueKey":"call.isNewContact","typeLabel":"boolean"},"isNewConversation":{"type":"boolean","example":false,"uniqueKey":"call.isNewConversation","typeLabel":"boolean"},"hasScheduledAutomation":{"type":"boolean","example":false,"uniqueKey":"call.hasScheduledAutomation","typeLabel":"boolean"},"botLoopCount":{"oneOf":[{"type":"number","uniqueKey":"call.botLoopCount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"call.botLoopCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.botLoopCount","typeLabel":"number | null"},"extraData":{"oneOf":[{"type":"object","description":"Dados extras do canal (ex.: anúncio de origem)","uniqueKey":"call.extraData.oneOf.0","typeLabel":"object"},{"type":"null","description":"Dados extras do canal (ex.: anúncio de origem)","uniqueKey":"call.extraData.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.extraData","typeLabel":"object | null"},"referral":{"oneOf":[{"type":"object","description":"Referral do WhatsApp (click-to-chat), quando houver","uniqueKey":"call.referral.oneOf.0","typeLabel":"object"},{"type":"null","description":"Referral do WhatsApp (click-to-chat), quando houver","uniqueKey":"call.referral.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.referral","typeLabel":"object | null"},"customFields":{"type":"object","description":"Campos customizados da sessão no formato { chave: { value } }","example":{"origem":{"value":"site"}},"uniqueKey":"call.customFields","typeLabel":"object"},"createdAt":{"type":"string","example":"2026-09-14T11:58:00.000Z","uniqueKey":"call.createdAt","typeLabel":"string"},"answeredAt":{"oneOf":[{"type":"string","example":"2026-09-14T12:00:00.000Z","uniqueKey":"call.answeredAt.oneOf.0","typeLabel":"string"},{"type":"null","example":"2026-09-14T12:00:00.000Z","uniqueKey":"call.answeredAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.answeredAt","typeLabel":"string | null"},"finishedAt":{"oneOf":[{"type":"string","example":"2026-09-14T12:30:00.000Z","uniqueKey":"call.finishedAt.oneOf.0","typeLabel":"string"},{"type":"null","example":"2026-09-14T12:30:00.000Z","uniqueKey":"call.finishedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.finishedAt","typeLabel":"string | null"},"callExpiresAt":{"oneOf":[{"type":"string","uniqueKey":"call.callExpiresAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"call.callExpiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.callExpiresAt","typeLabel":"string | null"},"firstOperatorMessageAt":{"oneOf":[{"type":"string","uniqueKey":"call.firstOperatorMessageAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"call.firstOperatorMessageAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.firstOperatorMessageAt","typeLabel":"string | null"},"lastOperatorMessageAt":{"oneOf":[{"type":"string","uniqueKey":"call.lastOperatorMessageAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"call.lastOperatorMessageAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.lastOperatorMessageAt","typeLabel":"string | null"},"firstCustomerMessageAt":{"oneOf":[{"type":"string","uniqueKey":"call.firstCustomerMessageAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"call.firstCustomerMessageAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.firstCustomerMessageAt","typeLabel":"string | null"},"lastCustomerMessageAt":{"oneOf":[{"type":"string","uniqueKey":"call.lastCustomerMessageAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"call.lastCustomerMessageAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"call.lastCustomerMessageAt","typeLabel":"string | null"}},"required":["id","customerPlatformId"],"isRequired":true,"uniqueKey":"call","typeLabel":"object"},"createdAt":{"type":"string","example":"2026-09-14T11:58:00.000Z","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","example":"2026-09-14T12:30:00.000Z","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"contact":{"type":"object","properties":{"id":{"type":"number","example":555,"uniqueKey":"contact.id","typeLabel":"number"},"name":{"type":"string","example":"João Silva","uniqueKey":"contact.name","typeLabel":"string"},"avatar":{"oneOf":[{"type":"string","uniqueKey":"contact.avatar.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"contact.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.avatar","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","example":"joao@gmail.com","uniqueKey":"contact.email.oneOf.0","typeLabel":"string"},{"type":"null","example":"joao@gmail.com","uniqueKey":"contact.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","example":"5585988887777","uniqueKey":"contact.phone.oneOf.0","typeLabel":"string"},{"type":"null","example":"5585988887777","uniqueKey":"contact.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.phone","typeLabel":"string | null"},"notes":{"oneOf":[{"type":"string","uniqueKey":"contact.notes.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"contact.notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.notes","typeLabel":"string | null"},"newContact":{"type":"boolean","example":false,"uniqueKey":"contact.newContact","typeLabel":"boolean"},"isPrivate":{"type":"boolean","example":false,"uniqueKey":"contact.isPrivate","typeLabel":"boolean"},"createdAt":{"type":"string","example":"2026-01-10T10:00:00.000Z","uniqueKey":"contact.createdAt","typeLabel":"string"},"customFields":{"type":"object","description":"Campos customizados do contato no formato { chave: { value } }","example":{"cpf":{"value":"000.000.000-00"}},"uniqueKey":"contact.customFields","typeLabel":"object"}},"uniqueKey":"contact","typeLabel":"object"},"conversation":{"type":"object","properties":{"id":{"type":"number","example":1234567,"description":"Id da conversa (customerPlatformId)","uniqueKey":"conversation.id","typeLabel":"number"},"customerId":{"type":"number","uniqueKey":"conversation.customerId","typeLabel":"number"},"platformId":{"type":"number","uniqueKey":"conversation.platformId","typeLabel":"number"},"workspacePlatformId":{"type":"number","example":103,"uniqueKey":"conversation.workspacePlatformId","typeLabel":"number"},"identifier":{"type":"string","example":"5585988887777","description":"Identificador do contato no canal (telefone, id do Instagram etc.)","uniqueKey":"conversation.identifier","typeLabel":"string"},"uniqueIdentifier":{"oneOf":[{"type":"string","uniqueKey":"conversation.uniqueIdentifier.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"conversation.uniqueIdentifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.uniqueIdentifier","typeLabel":"string | null"},"lastCallId":{"oneOf":[{"type":"number","uniqueKey":"conversation.lastCallId.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"conversation.lastCallId.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.lastCallId","typeLabel":"number | null"},"origin":{"oneOf":[{"type":"string","uniqueKey":"conversation.origin.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"conversation.origin.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.origin","typeLabel":"string | null"},"newCustomer":{"type":"boolean","example":false,"uniqueKey":"conversation.newCustomer","typeLabel":"boolean"},"hasNewMessages":{"type":"boolean","example":false,"uniqueKey":"conversation.hasNewMessages","typeLabel":"boolean"},"showPending":{"type":"boolean","example":false,"uniqueKey":"conversation.showPending","typeLabel":"boolean"},"wasImported":{"type":"boolean","example":false,"uniqueKey":"conversation.wasImported","typeLabel":"boolean"},"isDbMigrated":{"type":"boolean","example":false,"uniqueKey":"conversation.isDbMigrated","typeLabel":"boolean"},"isBlocked":{"type":"boolean","example":false,"uniqueKey":"conversation.isBlocked","typeLabel":"boolean"},"isGroup":{"type":"boolean","example":false,"uniqueKey":"conversation.isGroup","typeLabel":"boolean"},"importationTimestamp":{"oneOf":[{"type":"number","uniqueKey":"conversation.importationTimestamp.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"conversation.importationTimestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.importationTimestamp","typeLabel":"number | null"},"createdAt":{"oneOf":[{"type":"string","uniqueKey":"conversation.createdAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"conversation.createdAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.createdAt","typeLabel":"string | null"},"lastSeen":{"oneOf":[{"type":"string","uniqueKey":"conversation.lastSeen.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"conversation.lastSeen.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.lastSeen","typeLabel":"string | null"},"customerLastSeen":{"oneOf":[{"type":"string","uniqueKey":"conversation.customerLastSeen.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"conversation.customerLastSeen.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.customerLastSeen","typeLabel":"string | null"},"lastMessageAt":{"oneOf":[{"type":"string","uniqueKey":"conversation.lastMessageAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"conversation.lastMessageAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.lastMessageAt","typeLabel":"string | null"},"customerLastMessageAt":{"oneOf":[{"type":"string","uniqueKey":"conversation.customerLastMessageAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"conversation.customerLastMessageAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.customerLastMessageAt","typeLabel":"string | null"},"operatorLastMessageAt":{"oneOf":[{"type":"string","uniqueKey":"conversation.operatorLastMessageAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"conversation.operatorLastMessageAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.operatorLastMessageAt","typeLabel":"string | null"},"operatorLastMessageTriggerAt":{"oneOf":[{"type":"string","uniqueKey":"conversation.operatorLastMessageTriggerAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"conversation.operatorLastMessageTriggerAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.operatorLastMessageTriggerAt","typeLabel":"string | null"},"pendingAt":{"oneOf":[{"type":"string","uniqueKey":"conversation.pendingAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"conversation.pendingAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.pendingAt","typeLabel":"string | null"},"expirationDate":{"oneOf":[{"type":"string","description":"Fim da janela de 24h do WhatsApp, quando aplicável","uniqueKey":"conversation.expirationDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fim da janela de 24h do WhatsApp, quando aplicável","uniqueKey":"conversation.expirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.expirationDate","typeLabel":"string | null"}},"uniqueKey":"conversation","typeLabel":"object"},"lastMessage":{"type":"object","properties":{"idMessage":{"type":"number","example":37826587,"description":"Id da mensagem. Use em GET /v1/messages/{id}.","uniqueKey":"lastMessage.idMessage","typeLabel":"number"},"_id":{"type":"string","description":"ObjectId da mensagem","uniqueKey":"lastMessage._id","typeLabel":"string"},"operatorId":{"oneOf":[{"type":"number","uniqueKey":"lastMessage.operatorId.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"lastMessage.operatorId.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastMessage.operatorId","typeLabel":"number | null"},"content":{"type":"string","example":"[{\"insert\":\"Olá\"}]","uniqueKey":"lastMessage.content","typeLabel":"string"},"type":{"type":"number","example":0,"description":"0 comum, 1 sistema, 2 nota interna, 3 bot, 4 e-mail","uniqueKey":"lastMessage.type","typeLabel":"number"},"createdAt":{"type":"string","example":"2026-09-14T12:30:00.000Z","uniqueKey":"lastMessage.createdAt","typeLabel":"string"}},"uniqueKey":"lastMessage","typeLabel":"object"},"rating":{"oneOf":[{"type":"object","required":["value"],"properties":{"value":{"type":"number","example":5,"isRequired":true,"uniqueKey":"rating.oneOf.0.value","typeLabel":"number"},"operatorId":{"oneOf":[{"type":"number","uniqueKey":"rating.oneOf.0.operatorId.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"rating.oneOf.0.operatorId.oneOf.1","typeLabel":"null"}],"uniqueKey":"rating.oneOf.0.operatorId","typeLabel":"number | null"},"operatorName":{"oneOf":[{"type":"string","uniqueKey":"rating.oneOf.0.operatorName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"rating.oneOf.0.operatorName.oneOf.1","typeLabel":"null"}],"uniqueKey":"rating.oneOf.0.operatorName","typeLabel":"string | null"}},"uniqueKey":"rating.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"rating","typeLabel":"object | null"},"trails":{"description":"Histórico de quem assumiu a sessão","type":"array","items":{"type":"object","properties":{"date":{"type":"string","example":"2026-09-14T12:00:00.000Z","isRequired":true,"uniqueKey":"trails.items.[INDEX].date","typeLabel":"string"},"isodate":{"type":"string","example":"2026-09-14T12:00:00.000Z","isRequired":true,"uniqueKey":"trails.items.[INDEX].isodate","typeLabel":"string"},"type":{"type":"string","enum":["operator","bot","contact","automation","assignmentRule","group"],"example":"operator","isRequired":true,"uniqueKey":"trails.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"number","example":42,"description":"Id do operador, bot, grupo ou regra","isRequired":true,"uniqueKey":"trails.items.[INDEX].id","typeLabel":"number"}},"required":["date","isodate","type","id"],"uniqueKey":"trails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"trails","typeLabel":"object[]"},"interactions":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","example":"2026-09-14T12:00:00.000Z","isRequired":true,"uniqueKey":"interactions.items.[INDEX].date","typeLabel":"string"},"operatorId":{"type":"number","example":42,"isRequired":true,"uniqueKey":"interactions.items.[INDEX].operatorId","typeLabel":"number"}},"required":["date","operatorId"],"uniqueKey":"interactions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"interactions","typeLabel":"object[]"},"interactionDates":{"example":["2026-09-14"],"type":"array","items":{"type":"string","uniqueKey":"interactionDates.items.[INDEX]","typeLabel":"string"},"uniqueKey":"interactionDates","typeLabel":"string[]"},"tags":{"example":[3,8],"description":"Ids das tags da sessão","type":"array","items":{"type":"number","uniqueKey":"tags.items.[INDEX]","typeLabel":"number"},"uniqueKey":"tags","typeLabel":"number[]"},"followers":{"description":"Ids dos operadores seguindo a conversa","type":"array","items":{"type":"number","uniqueKey":"followers.items.[INDEX]","typeLabel":"number"},"uniqueKey":"followers","typeLabel":"number[]"},"scheduledMessages":{"description":"Ids das mensagens agendadas","type":"array","items":{"type":"number","uniqueKey":"scheduledMessages.items.[INDEX]","typeLabel":"number"},"uniqueKey":"scheduledMessages","typeLabel":"number[]"},"deals":{"oneOf":[{"type":"object","description":"Negócios (deals) vinculados","uniqueKey":"deals.oneOf.0","typeLabel":"object"},{"type":"null","description":"Negócios (deals) vinculados","uniqueKey":"deals.oneOf.1","typeLabel":"null"}],"uniqueKey":"deals","typeLabel":"object | null"},"operatorMessagesCount":{"type":"number","example":4,"uniqueKey":"operatorMessagesCount","typeLabel":"number"},"assignedOperatorMessagesCount":{"type":"number","example":4,"uniqueKey":"assignedOperatorMessagesCount","typeLabel":"number"},"botMessagesCount":{"type":"number","example":2,"uniqueKey":"botMessagesCount","typeLabel":"number"},"contactMessagesCount":{"type":"number","example":5,"uniqueKey":"contactMessagesCount","typeLabel":"number"},"totalMessagesCount":{"type":"number","example":11,"uniqueKey":"totalMessagesCount","typeLabel":"number"},"messagesCountByDate":{"type":"object","description":"Contagem de mensagens por dia: { \"2026-09-14\": { bot, operator, contact } }","example":{"2026-09-14":{"bot":2,"operator":4,"contact":5}},"uniqueKey":"messagesCountByDate","typeLabel":"object"},"tma":{"oneOf":[{"type":"number","example":1800,"description":"Tempo médio de atendimento, em segundos","uniqueKey":"tma.oneOf.0","typeLabel":"number"},{"type":"null","example":1800,"description":"Tempo médio de atendimento, em segundos","uniqueKey":"tma.oneOf.1","typeLabel":"null"}],"uniqueKey":"tma","typeLabel":"number | null"},"tme":{"oneOf":[{"type":"number","example":120,"description":"Tempo médio de espera, em segundos","uniqueKey":"tme.oneOf.0","typeLabel":"number"},{"type":"null","example":120,"description":"Tempo médio de espera, em segundos","uniqueKey":"tme.oneOf.1","typeLabel":"null"}],"uniqueKey":"tme","typeLabel":"number | null"},"tmp":{"oneOf":[{"type":"number","example":90,"description":"Tempo de primeira resposta, em segundos","uniqueKey":"tmp.oneOf.0","typeLabel":"number"},{"type":"null","example":90,"description":"Tempo de primeira resposta, em segundos","uniqueKey":"tmp.oneOf.1","typeLabel":"null"}],"uniqueKey":"tmp","typeLabel":"number | null"},"tmpResetOnNewAssignment":{"type":"boolean","example":false,"uniqueKey":"tmpResetOnNewAssignment","typeLabel":"boolean"},"summary":{"oneOf":[{"type":"string","description":"Resumo da sessão gerado por IA","uniqueKey":"summary.oneOf.0","typeLabel":"string"},{"type":"null","description":"Resumo da sessão gerado por IA","uniqueKey":"summary.oneOf.1","typeLabel":"null"}],"uniqueKey":"summary","typeLabel":"string | null"},"campaignId":{"oneOf":[{"type":"string","description":"Id da campanha que originou a sessão","uniqueKey":"campaignId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Id da campanha que originou a sessão","uniqueKey":"campaignId.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaignId","typeLabel":"string | null"},"mergedFromCustomerId":{"oneOf":[{"type":"string","uniqueKey":"mergedFromCustomerId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"mergedFromCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"mergedFromCustomerId","typeLabel":"string | null"}},"required":["id","_id","workspaceId","call","createdAt","updatedAt"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"66e2f1c9a1b2c3d4e5f60718","_id":"66e2f1c9a1b2c3d4e5f60718","workspaceId":1,"call":{"id":987654,"customerPlatformId":1234567,"workspacePlatformId":103,"operatorId":42,"groupId":10,"chatBotId":123,"lastBotId":123,"lastCallMessageId":123,"protocol":"2026091412345","uniqueIdentifier":"\u003cstring>","isFinished":false,"isChatBotActive":false,"isFromIntegration":false,"isHidden":false,"isImported":false,"isReopened":false,"isWithoutOperatorAnswer":false,"isWithoutClientAnswer":false,"isCreatedByActiveChat":false,"isRatingActive":false,"isNewContact":false,"isNewConversation":false,"hasScheduledAutomation":false,"botLoopCount":123,"extraData":{},"referral":{},"customFields":{"origem":{"value":"site"}},"createdAt":"2026-09-14T11:58:00.000Z","answeredAt":"2026-09-14T12:00:00.000Z","finishedAt":"2026-09-14T12:30:00.000Z","callExpiresAt":"\u003cstring>","firstOperatorMessageAt":"\u003cstring>","lastOperatorMessageAt":"\u003cstring>","firstCustomerMessageAt":"\u003cstring>","lastCustomerMessageAt":"\u003cstring>"},"createdAt":"2026-09-14T11:58:00.000Z","updatedAt":"2026-09-14T12:30:00.000Z","contact":{"id":555,"name":"João Silva","avatar":"\u003cstring>","email":"joao@gmail.com","phone":"5585988887777","notes":"\u003cstring>","newContact":false,"isPrivate":false,"createdAt":"2026-01-10T10:00:00.000Z","customFields":{"cpf":{"value":"000.000.000-00"}}},"conversation":{"id":1234567,"customerId":123,"platformId":123,"workspacePlatformId":103,"identifier":"5585988887777","uniqueIdentifier":"\u003cstring>","lastCallId":123,"origin":"\u003cstring>","newCustomer":false,"hasNewMessages":false,"showPending":false,"wasImported":false,"isDbMigrated":false,"isBlocked":false,"isGroup":false,"importationTimestamp":123,"createdAt":"\u003cstring>","lastSeen":"\u003cstring>","customerLastSeen":"\u003cstring>","lastMessageAt":"\u003cstring>","customerLastMessageAt":"\u003cstring>","operatorLastMessageAt":"\u003cstring>","operatorLastMessageTriggerAt":"\u003cstring>","pendingAt":"\u003cstring>","expirationDate":"\u003cstring>"},"lastMessage":{"idMessage":37826587,"_id":"\u003cstring>","operatorId":123,"content":"[{\"insert\":\"Olá\"}]","type":0,"createdAt":"2026-09-14T12:30:00.000Z"},"rating":{"value":5,"operatorId":123,"operatorName":"\u003cstring>"},"trails":[{"date":"2026-09-14T12:00:00.000Z","isodate":"2026-09-14T12:00:00.000Z","type":"operator","id":42}],"interactions":[{"date":"2026-09-14T12:00:00.000Z","operatorId":42}],"interactionDates":["2026-09-14"],"tags":[3,8],"followers":[123],"scheduledMessages":[123],"deals":{},"operatorMessagesCount":4,"assignedOperatorMessagesCount":4,"botMessagesCount":2,"contactMessagesCount":5,"totalMessagesCount":11,"messagesCountByDate":{"2026-09-14":{"bot":2,"operator":4,"contact":5}},"tma":1800,"tme":120,"tmp":90,"tmpResetOnNewAssignment":false,"summary":"\u003cstring>","campaignId":"\u003cstring>","mergedFromCustomerId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"cbddb0de-e903-4cc4-8b9e-06239398f680":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"openapi.json"},"subdomain":"kinbox","siteName":"Kinbox Docs","title":"Retrieve a session - Kinbox Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-14T20:27:16.855Z","originalFileLocation":"api-reference/sessions/retrieve-a-session.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=\"Accepts either the session id (Mongo ObjectId) or the call id (numeric). If the id is purely numeric, the session is looked up by call.id.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kinbox Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a session - Kinbox Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Accepts either the session id (Mongo ObjectId) or the call id (numeric). If the id is purely numeric, the session is looked up by call.id.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kinbox Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.kinbox.com.br/api-reference/sessions/retrieve-a-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kinbox.mintlify.site/_mintlify/api/og/v2?division=Sess%C3%B5es\u0026amp;title=Retrieve+a+session\u0026amp;description=Accepts+either+the+session+id+%28Mongo+ObjectId%29+or+the+call+id+%28numeric%29.+If+the+id+is+purely+numeric%2C+the+session+is+looked+up+by+call.id.\u0026amp;theme=913137be1e95efb95a5b7d76\u0026amp;signature=f98e31b85e42c853392b87a2b26679f4516ba8f90fd226ce1eb37f90a877ae32\">\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=\"Retrieve a session - Kinbox Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Accepts either the session id (Mongo ObjectId) or the call id (numeric). If the id is purely numeric, the session is looked up by call.id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kinbox.mintlify.site/_mintlify/api/og/v2?division=Sess%C3%B5es\u0026amp;title=Retrieve+a+session\u0026amp;description=Accepts+either+the+session+id+%28Mongo+ObjectId%29+or+the+call+id+%28numeric%29.+If+the+id+is+purely+numeric%2C+the+session+is+looked+up+by+call.id.\u0026amp;theme=913137be1e95efb95a5b7d76\u0026amp;signature=f98e31b85e42c853392b87a2b26679f4516ba8f90fd226ce1eb37f90a877ae32\">\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/kinbox/N2Me7JDxF3wwPtrk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kinbox Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#367fee\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.kinbox.com.br/api-reference/sessions/retrieve-a-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sessions/retrieve-a-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.kinbox.com.br/#organization\",\"name\":\"Kinbox Docs\",\"url\":\"https://developer.kinbox.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kinbox/rfT19ZB_LIv08ILX/logo/light.svg?fit=max\u0026auto=format\u0026n=rfT19ZB_LIv08ILX\u0026q=85\u0026s=fa93682e7b102a1661ad9c08e9351d06\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.kinbox.com.br#website\",\"name\":\"Kinbox Docs\",\"url\":\"https://developer.kinbox.com.br\",\"publisher\":{\"@id\":\"https://developer.kinbox.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.kinbox.com.br/api-reference/sessions/retrieve-a-session#webpage\",\"url\":\"https://developer.kinbox.com.br/api-reference/sessions/retrieve-a-session\",\"name\":\"Retrieve a session\",\"description\":\"Accepts either the session id (Mongo ObjectId) or the call id (numeric). If the id is purely numeric, the session is looked up by call.id.\",\"dateModified\":\"2026-09-14T20:27:16.855Z\",\"isPartOf\":{\"@id\":\"https://developer.kinbox.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developer.kinbox.com.br/api-reference/sessions/retrieve-a-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.kinbox.com.br/api-reference/sessions/retrieve-a-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sessões\",\"item\":\"https://developer.kinbox.com.br/api-reference/sessions/list-all-sessions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve a session\",\"item\":\"https://developer.kinbox.com.br/api-reference/sessions/retrieve-a-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.kinbox.com.br/api-reference/sessions/retrieve-a-session#apireference\",\"headline\":\"Retrieve a session\",\"name\":\"Retrieve a session\",\"description\":\"Accepts either the session id (Mongo ObjectId) or the call id (numeric). If the id is purely numeric, the session is looked up by call.id.\",\"url\":\"https://developer.kinbox.com.br/api-reference/sessions/retrieve-a-session\",\"mainEntityOfPage\":{\"@id\":\"https://developer.kinbox.com.br/api-reference/sessions/retrieve-a-session#webpage\"},\"dateModified\":\"2026-09-14T20:27:16.855Z\",\"publisher\":{\"@id\":\"https://developer.kinbox.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.kinbox.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kinbox Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Kinbox Docs","nav":{"global":null,"tabs":[{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"title":"Autenticação","href":"/api-reference/authentication"},{"title":"Campos personalizados","href":"/api-reference/custom-fields"}]},{"group":"Contatos","icon":"address-card","pages":[{"openapi":"get /v1/contacts","title":"List all contacts","href":"/api-reference/contacts/list-all-contacts"},{"openapi":"get /v1/contacts/{id}","title":"Retrieve a contact","href":"/api-reference/contacts/retrieve-a-contact"},{"openapi":"post /v1/contacts","title":"Create a contact","href":"/api-reference/contacts/create-a-contact"},{"openapi":"patch /v1/contacts/{id}","title":"Update a contact","href":"/api-reference/contacts/update-a-contact"}]},{"group":"Campos personalizados","icon":"keyboard","pages":[{"openapi":"get /v1/custom-fields","title":"List all custom fields","href":"/api-reference/custom-fields/list-all-custom-fields"},{"openapi":"get /v1/custom-fields/{id}","title":"Retrieve a custom field","href":"/api-reference/custom-fields/retrieve-a-custom-field"}]},{"group":"Tags","icon":"tags","pages":[{"openapi":"get /v1/tags","title":"List all tags","href":"/api-reference/tags/list-all-tags"},{"openapi":"get /v1/tags/{id}","title":"Retrieve a tag","href":"/api-reference/tags/retrieve-a-tag"},{"openapi":"post /v1/tags","title":"Create a tag","href":"/api-reference/tags/create-a-tag"},{"openapi":"patch /v1/tags/{id}","title":"Update a tag","href":"/api-reference/tags/update-a-tag"},{"openapi":"delete /v1/tags/{id}","title":"Delete a tag","href":"/api-reference/tags/delete-a-tag"}]},{"group":"Produtos","icon":"barcode","pages":[{"openapi":"get /v1/products","title":"List all products","href":"/api-reference/products/list-all-products"},{"openapi":"get /v1/products/{id}","title":"Retrieve a product","href":"/api-reference/products/retrieve-a-product"},{"openapi":"post /v1/products","title":"Create a product","href":"/api-reference/products/create-a-product"},{"openapi":"patch /v1/products/{id}","title":"Update a product","href":"/api-reference/products/update-a-product"},{"openapi":"delete /v1/products/{id}","title":"Delete a product","href":"/api-reference/products/delete-a-product"},{"openapi":"get /v1/products/external/{externalId}","title":"Retrieve a product by external id","href":"/api-reference/products/retrieve-a-product-by-external-id"}]},{"group":"Negócios","icon":"badge-dollar","pages":[{"openapi":"get /v1/deals","title":"List all deals","href":"/api-reference/deals/list-all-deals"},{"openapi":"get /v1/deals/{id}","title":"Retrieve a deal","href":"/api-reference/deals/retrieve-a-deal"},{"openapi":"post /v1/deals","title":"Create a deal","href":"/api-reference/deals/create-a-deal"},{"openapi":"patch /v1/deals/{id}","title":"Update a deal","href":"/api-reference/deals/update-a-deal"},{"openapi":"delete /v1/deals/{id}","title":"Delete a deal","href":"/api-reference/deals/delete-a-deal"}]},{"group":"Funis","icon":"filter","pages":[{"openapi":"get /v1/pipelines","title":"List all pipelines","href":"/api-reference/pipelines/list-all-pipelines"},{"openapi":"get /v1/pipelines/{id}","title":"Retrieve a pipeline","href":"/api-reference/pipelines/retrieve-a-pipeline"},{"openapi":"post /v1/pipelines","title":"Create a pipeline","href":"/api-reference/pipelines/create-a-pipeline"},{"openapi":"patch /v1/pipelines/{id}","title":"Update a pipeline","href":"/api-reference/pipelines/update-a-pipeline"},{"openapi":"delete /v1/pipelines/{id}","title":"Delete a pipeline","href":"/api-reference/pipelines/delete-a-pipeline"}]},{"group":"Campanhas","icon":"bullseye-arrow","pages":[{"openapi":"get /v1/campaigns","title":"List all campaigns","href":"/api-reference/campaigns/list-all-campaigns"},{"openapi":"get /v1/campaigns/{id}","title":"Retrieve a campaign","href":"/api-reference/campaigns/retrieve-a-campaign"},{"openapi":"post /v1/campaigns","title":"Create a campaign","href":"/api-reference/campaigns/create-a-campaign"},{"openapi":"patch /v1/campaigns/{id}","title":"Update a campaign","href":"/api-reference/campaigns/update-a-campaign"},{"openapi":"delete /v1/campaigns/{id}","title":"Delete a campaign","href":"/api-reference/campaigns/delete-a-campaign"},{"openapi":"post /v1/campaigns/{id}/pause","title":"Pause a campaign","href":"/api-reference/campaigns/pause-a-campaign"},{"openapi":"post /v1/campaigns/{id}/resume","title":"Resume a campaign","href":"/api-reference/campaigns/resume-a-campaign"},{"openapi":"get /v1/campaigns/{id}/chunk-leads","title":"Get campaign leads","href":"/api-reference/campaigns/get-campaign-leads"}]},{"group":"Sessões","icon":"comments","pages":[{"openapi":"get /v1/sessions","title":"List all sessions","description":null,"href":"/api-reference/sessions/list-all-sessions"},{"openapi":"get /v1/sessions/{id}","title":"Retrieve a session","href":"/api-reference/sessions/retrieve-a-session"}]},{"group":"Mensagens","icon":"message","pages":[{"openapi":"post /v1/messages/send","title":"Send a message","description":"Queues a message to a phone number through one of the workspace channels. Official WhatsApp channels (with waba_id) require a `template` for contacts outside the 24h window. Use the returned id with GET /v1/messages/queue/{id} to track delivery.","href":"/api-reference/messages/send-a-message"},{"openapi":"get /v1/messages/queue/{id}","title":"Retrieve queued message status","href":"/api-reference/messages/retrieve-queued-message-status"},{"openapi":"get /v1/messages/{id}","title":"Retrieve a message","href":"/api-reference/messages/retrieve-a-message"},{"openapi":"get /v1/conversations/{id}/messages","title":"List conversation messages","href":"/api-reference/messages/list-conversation-messages"}]},{"group":"Canais","icon":"plug","pages":[{"openapi":"get /v1/channels","title":"List all channels","href":"/api-reference/channels/list-all-channels"},{"openapi":"get /v1/channels/{id}","title":"Retrieve a channel","href":"/api-reference/channels/retrieve-a-channel"},{"openapi":"get /v1/channels/{id}/templates","title":"List channel templates","href":"/api-reference/channels/list-channel-templates"},{"openapi":"get /v1/channels/{id}/check-whatsapp","title":"Check if a phone has WhatsApp","href":"/api-reference/channels/check-if-a-phone-has-whatsapp"}]},{"group":"Grupos","icon":"users","pages":[{"openapi":"get /v1/groups","title":"List all groups","href":"/api-reference/groups/list-all-groups"},{"openapi":"get /v1/groups/{id}","title":"Retrieve a group","href":"/api-reference/groups/retrieve-a-group"},{"openapi":"get /v1/groups/{id}/users","title":"List group users","href":"/api-reference/groups/list-group-users"},{"openapi":"get /v1/groups/{id}/users/{userId}","title":"Retrieve a group user","href":"/api-reference/groups/retrieve-a-group-user"}]},{"group":"Frases rápidas","icon":"bolt","pages":[{"openapi":"get /v1/quick-phrases","title":"List all quick phrases","href":"/api-reference/quick-phrases/list-all-quick-phrases"},{"openapi":"get /v1/quick-phrases/{id}","title":"Retrieve a quick phrase","href":"/api-reference/quick-phrases/retrieve-a-quick-phrase"}]}]}]},"basePath":"","title":"Retrieve a session - Kinbox Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-BUDYNlhG.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}