{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Birdeye Developer Portal","colors":{"primary":"#007AFF","light":"#3395FF","dark":"#0055CC"},"logo":{"light":"https://mintcdn.com/birdeye-0229a3ce/UGWhTcR8ROU1U6UM/images/birdeye-vector-logo.svg?fit=max\u0026auto=format\u0026n=UGWhTcR8ROU1U6UM\u0026q=85\u0026s=2a909a704f4e2bbfdc09801f660a2265","dark":"https://mintcdn.com/birdeye-0229a3ce/fd4F54fLnDLtDWF0/images/birdeye-vector-logo-dark.svg?fit=max\u0026auto=format\u0026n=fd4F54fLnDLtDWF0\u0026q=85\u0026s=8c188d7bcbf3c5140059fc0044e4d385"},"favicon":"https://mintcdn.com/birdeye-0229a3ce/hPnwFq14OPbAVJLt/images/birdeye-favicon.svg?fit=max\u0026auto=format\u0026n=hPnwFq14OPbAVJLt\u0026q=85\u0026s=e82b5184dbaedf10e12df434049ed2e6","api":{"examples":{"prefill":true}},"navbar":{"links":[{"href":"https://birdeye.com","label":"Birdeye"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/birdeye"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"birdeye-0229a3ce","hasAudioNarration":false,"actualSubdomain":"birdeye-0229a3ce","customDomains":["docs.birdeye.com"],"gitSource":{"type":"github","owner":"birdeyeinc","repo":"birdeye-api-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"0bc25e83-7973-474d-98c9-a13f1ed6cd33","liveDeploymentHistoryId":"6adb43a225769d6ebcdbd033","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb43a225769d6ebcdbd033"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adb43a225769d6ebcdbd033","clientVersion":"0.0.4039","searchFilterCounts":[{"language":"default","tag":"API Reference","count":213},{"language":"default","tag":"Reference","count":207},{"language":"default","tag":"MCP","count":107},{"language":"default","tag":"Tools","count":102},{"language":"default","tag":"Business","count":25},{"language":"default","tag":"Reviews","count":23},{"language":"default","tag":"Insight AI","count":18},{"language":"default","tag":"Report","count":18},{"language":"default","tag":"Contact","count":17},{"language":"default","tag":"Listing","count":17}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":".nav-tabs-item{font-weight:600!important}.nav-tabs-item[aria-current=location],.nav-tabs-item[data-active=true]{font-weight:700!important}[class*=branding],[class*=powered],a[href*=\"mintlify.com\"]{display:none!important}"}],"page":{"pagePath":"api/conversation/list-conversations","slug":"/api/conversation/list-conversations","pageMetadata":{"title":"List Conversations","openapi":"api/openapi.yaml POST /v1/messenger/export","description":"List Conversations retrieves conversations for a business.","href":"/api/conversation/list-conversations"},"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: \"List Conversations retrieves conversations for a business.\"\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":"List Conversations","openapi":"api/openapi.yaml POST /v1/messenger/export","description":"List Conversations retrieves conversations for a business.","href":"/api/conversation/list-conversations"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"responses":{"200":"aba2b5f6-6718-49a0-bd6d-fcb31384b38f","400":"58092c5f-5a9c-4c4e-b80f-e9a025e51ff9","401":"2fae0773-e970-4da7-9934-d6844527a77b","404":"f5a6d003-6b21-4682-be2b-40244c019488","429":"ba0713af-151f-49af-bcf8-ad8f111ee259"},"summary":"List Conversations","operationId":"listConversations","description":"List Conversations retrieves conversations for a business.","tags":["Conversation"],"parameters":["d7549c1b-cee0-4a65-b5b3-06fb30139d8c","def5343d-78af-49a1-8357-c42bc7087604"],"requestBody":"93c441e9-a08e-45a7-ad6c-1ba8d2b21a3c","method":"post","type":"path","servers":["f50b9d30-5cd5-4d34-9445-d1b5377cec53"],"security":[],"path":"/v1/messenger/export","baseUrlOptions":["https://api.birdeye.com/resources"],"title":"List Conversations","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.businessNumber":"755009344","body.apiKey":"abcdefgh","body.startDate":"04/06/2020","body.endDate":"05/30/2020","body.offset":"0","body.size":"100","body.contact.phone":"(650)492-3456","body.contact.email":"abc@test.com","body.excludeCampaignMessages":1}]},"dependencies":{"parameters":{"d7549c1b-cee0-4a65-b5b3-06fb30139d8c":{"name":"Accept","in":"header","description":"Preferred response media type.","required":false,"example":"application/json","schema":{"type":"string","default":"application/json","isRequired":false,"description":"Preferred response media type.","uniqueKey":"","typeLabel":"string"}},"def5343d-78af-49a1-8357-c42bc7087604":{"name":"Content-Type","in":"header","description":"Media type of the JSON request body.","required":false,"example":"application/json","schema":{"type":"string","default":"application/json","isRequired":false,"description":"Media type of the JSON request body.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"businessNumber":{"type":"number","description":"The business number for which the details to be fetched, it can be either enterprise or location business number.","isRequired":true,"uniqueKey":"businessNumber","typeLabel":"number"},"apiKey":{"type":"string","description":"Partner specific API key provided by Birdeye for data exchange.","isRequired":true,"uniqueKey":"apiKey","typeLabel":"string"},"startDate":{"type":"string","description":"Start fetching messages from this date in MM/DD/YYYY format.","uniqueKey":"startDate","typeLabel":"string"},"endDate":{"type":"string","description":"Fetch messages till this date in MM/DD/YYYY format.","uniqueKey":"endDate","typeLabel":"string"},"offset":{"type":"number","description":"Message offset,the start index.","uniqueKey":"offset","typeLabel":"number"},"size":{"type":"number","description":"Number of messages return in the response.","uniqueKey":"size","typeLabel":"number"},"contact":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number of the contact.","uniqueKey":"contact.phone","typeLabel":"string"},"email":{"type":"string","description":"Email Id of the contact.","uniqueKey":"contact.email","typeLabel":"string"}},"description":"Contact details","uniqueKey":"contact","typeLabel":"object"},"excludeCampaignMessages":{"type":"number","description":"If passed with value 1, It will exclude campaign messages from API response.","uniqueKey":"excludeCampaignMessages","typeLabel":"number"}},"required":["businessNumber","apiKey"],"example":{"businessNumber":"755009344","apiKey":"abcdefgh","startDate":"04/06/2020","endDate":"05/30/2020","offset":"0","size":"100","contact":{"phone":"(650)492-3456","email":"abc@test.com"},"excludeCampaignMessages":1},"uniqueKey":"","typeLabel":"object"},"example":{"businessNumber":"755009344","apiKey":"abcdefgh","startDate":"04/06/2020","endDate":"05/30/2020","offset":"0","size":"100","contact":{"phone":"(650)492-3456","email":"abc@test.com"},"excludeCampaignMessages":1},"examples":{"Example":{"title":"Example","value":{"businessNumber":"755009344","apiKey":"abcdefgh","startDate":"04/06/2020","endDate":"05/30/2020","offset":"0","size":"100","contact":{"phone":"(650)492-3456","email":"abc@test.com"},"excludeCampaignMessages":1}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"aba2b5f6-6718-49a0-bd6d-fcb31384b38f":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"totalConversations":{"type":"number","description":"The number of total conversation objects that can be retrieved through pagination.","uniqueKey":"totalConversations","typeLabel":"number"},"totalMessages":{"type":"string","description":"The number of total message objects that can be retrieved through pagination.","uniqueKey":"totalMessages","typeLabel":"string"},"conversations":{"type":"array","description":"List of conversations.","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique ID generated by the Birdeye platform that identifies this conversation.","uniqueKey":"conversations.items.[INDEX].id","typeLabel":"string"},"contact":{"type":"object","properties":{"id":{"type":"number","description":"Contact id.","uniqueKey":"conversations.items.[INDEX].contact.id","typeLabel":"number"},"name":{"type":"string","description":"Contact name.","uniqueKey":"conversations.items.[INDEX].contact.name","typeLabel":"string"},"firstName":{"type":"string","description":"Contact first name.","uniqueKey":"conversations.items.[INDEX].contact.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Contact last name.","uniqueKey":"conversations.items.[INDEX].contact.lastName","typeLabel":"string"},"phone":{"type":"string","description":"Phone number of the contact.","uniqueKey":"conversations.items.[INDEX].contact.phone","typeLabel":"string"},"emailId":{"type":"string","description":"Email Id of the contact.","uniqueKey":"conversations.items.[INDEX].contact.emailId","typeLabel":"string"},"createdDate":{"type":"string","description":"Contact creation date.","uniqueKey":"conversations.items.[INDEX].contact.createdDate","typeLabel":"string"},"updatedDate":{"type":"string","description":"Contact updation date.","uniqueKey":"conversations.items.[INDEX].contact.updatedDate","typeLabel":"string"},"team":{"type":"string","description":"Team name.","uniqueKey":"conversations.items.[INDEX].contact.team","typeLabel":"string"},"locationId":{"type":"string","description":"Location Id to which contact is attached.","uniqueKey":"conversations.items.[INDEX].contact.locationId","typeLabel":"string"}},"description":"Contact details.","uniqueKey":"conversations.items.[INDEX].contact","typeLabel":"object"},"messages":{"type":"array","items":{"type":"object","properties":{"sentAt":{"type":"number","description":"Epoc time of the message.","uniqueKey":"conversations.items.[INDEX].messages.items.[INDEX].sentAt","typeLabel":"number"},"id":{"type":"number","description":"Message id.","uniqueKey":"conversations.items.[INDEX].messages.items.[INDEX].id","typeLabel":"number"},"text":{"type":"string","description":"Message text.","uniqueKey":"conversations.items.[INDEX].messages.items.[INDEX].text","typeLabel":"string"},"attachments":{"type":"object","description":"Attachment details.","uniqueKey":"conversations.items.[INDEX].messages.items.[INDEX].attachments","typeLabel":"object"},"direction":{"type":"string","description":"Message direction, SEND or RECEIVE.","uniqueKey":"conversations.items.[INDEX].messages.items.[INDEX].direction","typeLabel":"string"},"channel":{"type":"string","description":"A unique identifier that is used to send or receive the message.for example: sms, email or Live_chat.","uniqueKey":"conversations.items.[INDEX].messages.items.[INDEX].channel","typeLabel":"string"}},"uniqueKey":"conversations.items.[INDEX].messages.items.[INDEX]","typeLabel":"object"},"description":"List of messages.","uniqueKey":"conversations.items.[INDEX].messages","typeLabel":"object[]"},"conversation_start_date":{"type":"string","description":"The date conversation.","uniqueKey":"conversations.items.[INDEX].conversation_start_date","typeLabel":"string"},"last_message_received_on":{"type":"string","description":"The date on which the last message was recieved within the defined date range.","uniqueKey":"conversations.items.[INDEX].last_message_received_on","typeLabel":"string"},"status":{"type":"string","description":"Status of the conversation, OPEN or CLOSE.","uniqueKey":"conversations.items.[INDEX].status","typeLabel":"string"},"last_used_channel":{"type":"string","description":"Last used channel.","uniqueKey":"conversations.items.[INDEX].last_used_channel","typeLabel":"string"},"assigned_to":{"type":"object","properties":{"id":{"type":"number","description":"Id of the user.","uniqueKey":"conversations.items.[INDEX].assigned_to.id","typeLabel":"number"},"name":{"type":"string","description":"Name of the Assignee.","uniqueKey":"conversations.items.[INDEX].assigned_to.name","typeLabel":"string"},"type":{"type":"string","description":"Type of Assignee.","uniqueKey":"conversations.items.[INDEX].assigned_to.type","typeLabel":"string"},"emailId":{"type":"string","description":"Email id of Assignee.","uniqueKey":"conversations.items.[INDEX].assigned_to.emailId","typeLabel":"string"}},"description":"Assinee details.","uniqueKey":"conversations.items.[INDEX].assigned_to","typeLabel":"object"}},"uniqueKey":"conversations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"conversations","typeLabel":"object[]"},"hasMore":{"type":"boolean","description":"Indicates if there are more conversations.","uniqueKey":"hasMore","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"example":{"totalConversations":1,"totalMessages":2,"conversations":[{"id":127490,"contact":{"id":80768826,"name":"S G","firstName":"S","lastName":"G","phone":"(650) 492-3456","emailId":null,"createdDate":"2020-05-04 17:20:14","updatedDate":"2020-05-18 15:22:57","team":"Harshit","locationId":155911960965004},"messages":[{"sentAt":1588612840000,"id":"124776","text":"hi","message_date":"May 04, 2020 10:20 AM PDT","attachments":null,"direction":"SEND","channel":"SMS"},{"sentAt":1588612814000,"id":"124775","text":"Hello","message_date":"May 04, 2020 10:20 AM PDT","attachments":null,"direction":"RECEIVE","channel":"LIVE_CHAT"}],"conversation_start_date":"May 04, 2020 10:20 AM PDT","last_message_received_on":"May 04, 2020 10:20 AM PDT","status":"OPEN","last_used_channel":"SMS","assigned_to":{"id":-100000,"name":"","type":"T","emailId":null}}],"hasMore":false},"examples":{"Example":{"title":"Example","value":{"totalConversations":1,"totalMessages":2,"conversations":[{"id":127490,"contact":{"id":80768826,"name":"S G","firstName":"S","lastName":"G","phone":"(650) 492-3456","emailId":null,"createdDate":"2020-05-04 17:20:14","updatedDate":"2020-05-18 15:22:57","team":"Harshit","locationId":155911960965004},"messages":[{"sentAt":1588612840000,"id":"124776","text":"hi","message_date":"May 04, 2020 10:20 AM PDT","attachments":null,"direction":"SEND","channel":"SMS"},{"sentAt":1588612814000,"id":"124775","text":"Hello","message_date":"May 04, 2020 10:20 AM PDT","attachments":null,"direction":"RECEIVE","channel":"LIVE_CHAT"}],"conversation_start_date":"May 04, 2020 10:20 AM PDT","last_message_received_on":"May 04, 2020 10:20 AM PDT","status":"OPEN","last_used_channel":"SMS","assigned_to":{"id":-100000,"name":"","type":"T","emailId":null}}],"hasMore":false}}},"exampleType":"examples"}},"exampleType":"examples"},"58092c5f-5a9c-4c4e-b80f-e9a025e51ff9":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"number","uniqueKey":"code","typeLabel":"number"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"example":{"code":1246,"message":"Customer email or phone number is required."},"uniqueKey":"","typeLabel":"object"},"examples":{"response":{"title":"response","value":{"code":1246,"message":"Customer email or phone number is required."}}},"exampleType":"examples"}},"exampleType":"examples"},"2fae0773-e970-4da7-9934-d6844527a77b":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"number","uniqueKey":"code","typeLabel":"number"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"example":{"code":1161,"message":"Invalid API key"},"uniqueKey":"","typeLabel":"object"},"x-apiary-response-models":[{"$ref":"#/components/schemas/1161Model"},{"$ref":"#/components/schemas/1167Model"}],"x-apiary-response-examples":{"error_1161":{"value":{"code":1161,"message":"Invalid API key"}},"error_1167":{"value":{"code":1167,"message":"API key is missing"}}},"examples":{"response":{"title":"response","value":{"code":1161,"message":"Invalid API key"}}},"exampleType":"examples"}},"exampleType":"examples"},"f5a6d003-6b21-4682-be2b-40244c019488":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"number","uniqueKey":"code","typeLabel":"number"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"example":{"code":1011,"message":"Business id is invalid"},"uniqueKey":"","typeLabel":"object"},"examples":{"response":{"title":"response","value":{"code":1011,"message":"Business id is invalid"}}},"exampleType":"examples"}},"exampleType":"examples"},"ba0713af-151f-49af-bcf8-ad8f111ee259":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"number","uniqueKey":"code","typeLabel":"number"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"example":{"code":89,"message":"Rate limit exceeded"},"uniqueKey":"","typeLabel":"object"},"examples":{"response":{"title":"response","value":{"code":89,"message":"Rate limit exceeded"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"f50b9d30-5cd5-4d34-9445-d1b5377cec53":{"url":"https://api.birdeye.com/resources"}}},"originalFileLocation":"api/openapi.yaml"},"subdomain":"birdeye-0229a3ce","siteName":"Birdeye Developer Portal","title":"List Conversations - Birdeye Developer Portal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-17T11:34:55.827Z","originalFileLocation":"api/conversation/list-conversations.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=\"List Conversations retrieves conversations for a business.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Birdeye Developer Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_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/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/birdeye-0229a3ce/emhvamJ1iO9evqX0/_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/birdeye-0229a3ce/emhvamJ1iO9evqX0/_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/birdeye-0229a3ce/emhvamJ1iO9evqX0/_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/birdeye-0229a3ce/emhvamJ1iO9evqX0/_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/birdeye-0229a3ce/emhvamJ1iO9evqX0/_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/birdeye-0229a3ce/emhvamJ1iO9evqX0/_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/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Conversations - Birdeye Developer Portal\">\u003cmeta data-mint-head property=\"og:description\" content=\"List Conversations retrieves conversations for a business.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Birdeye Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birdeye.com/api/conversation/list-conversations\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://birdeye-0229a3ce.mintlify.app/_mintlify/api/og/v2?division=Conversation\u0026amp;title=List+Conversations\u0026amp;description=List+Conversations+retrieves+conversations+for+a+business.\u0026amp;theme=727e5f15fe4ee7dd4f2ad978\u0026amp;signature=fc6ca304b23b968f236e4629ccf555c3ffd4006c0b01dd5b47f5102841e93f64\">\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=\"List Conversations - Birdeye Developer Portal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List Conversations retrieves conversations for a business.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birdeye-0229a3ce.mintlify.app/_mintlify/api/og/v2?division=Conversation\u0026amp;title=List+Conversations\u0026amp;description=List+Conversations+retrieves+conversations+for+a+business.\u0026amp;theme=727e5f15fe4ee7dd4f2ad978\u0026amp;signature=fc6ca304b23b968f236e4629ccf555c3ffd4006c0b01dd5b47f5102841e93f64\">\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/birdeye-0229a3ce/emhvamJ1iO9evqX0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Birdeye Developer Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007AFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.birdeye.com/api/conversation/list-conversations\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/conversation/list-conversations.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.birdeye.com/#organization\",\"name\":\"Birdeye Developer Portal\",\"url\":\"https://docs.birdeye.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/birdeye-0229a3ce/UGWhTcR8ROU1U6UM/images/birdeye-vector-logo.svg?fit=max\u0026auto=format\u0026n=UGWhTcR8ROU1U6UM\u0026q=85\u0026s=2a909a704f4e2bbfdc09801f660a2265\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.birdeye.com#website\",\"name\":\"Birdeye Developer Portal\",\"url\":\"https://docs.birdeye.com\",\"publisher\":{\"@id\":\"https://docs.birdeye.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.birdeye.com/api/conversation/list-conversations#webpage\",\"url\":\"https://docs.birdeye.com/api/conversation/list-conversations\",\"name\":\"List Conversations\",\"description\":\"List Conversations retrieves conversations for a business.\",\"dateModified\":\"2026-07-17T11:34:55.827Z\",\"isPartOf\":{\"@id\":\"https://docs.birdeye.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birdeye.com/api/conversation/list-conversations#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birdeye.com/api/conversation/list-conversations#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.birdeye.com/api/business/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Conversation\",\"item\":\"https://docs.birdeye.com/api/conversation/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List Conversations\",\"item\":\"https://docs.birdeye.com/api/conversation/list-conversations\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birdeye.com/api/conversation/list-conversations#apireference\",\"headline\":\"List Conversations\",\"name\":\"List Conversations\",\"description\":\"List Conversations retrieves conversations for a business.\",\"url\":\"https://docs.birdeye.com/api/conversation/list-conversations\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birdeye.com/api/conversation/list-conversations#webpage\"},\"dateModified\":\"2026-07-17T11:34:55.827Z\",\"publisher\":{\"@id\":\"https://docs.birdeye.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.birdeye.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Birdeye Developer Portal\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Birdeye Developer Portal","nav":{"global":null,"tabs":[{"tab":"MCP","icon":"https://mintlify.s3.us-west-1.amazonaws.com/birdeye-0229a3ce/images/mcp.svg","pages":[{"title":"MCP","href":"/mcp/introduction"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Get Started","icon":"rocket","pages":[{"title":"Introduction","href":"/api/introduction"},{"title":"Authentication and Rate limiting","href":"/api/authentication"},{"title":"Pagination","href":"/api/pagination"},{"title":"HTTP Status Codes","href":"/api/http-status-codes"},{"title":"Error Response","href":"/api/error-response"},{"title":"Change Logs","href":"/api/changelog"}]},{"group":"Reference","pages":[{"group":"Business","icon":"building","pages":[{"title":"Business","href":"/api/business/overview"},{"title":"Create Business","openapi":"api/openapi.yaml POST /v1/signup/reseller/subaccount","href":"/api/business/create-a-business"},{"title":"Search","openapi":"api/openapi.yaml POST /v1/business/{businessNumber}/search","href":"/api/business/search-business"},{"title":"Get","openapi":"api/openapi.yaml GET /v1/business/{business_id}","href":"/api/business/get-business"},{"title":"Update","openapi":"api/openapi.yaml PUT /v1/business/{businessId}","href":"/api/business/update-business"},{"title":"Delete","openapi":"api/openapi.yaml DELETE /v1/business/{business_Id}","href":"/api/business/delete-business"},{"title":"Status Update","openapi":"api/openapi.yaml PUT /v1/business/{business_id}/status","href":"/api/business/update-the-status"},{"title":"Child Businesses","openapi":"api/openapi.yaml GET /v1/business/child/all","href":"/api/business/get-child-businesses"},{"title":"Public profile tabs","openapi":"api/openapi.yaml POST /v1/business/tabs","href":"/api/business/update-public-profile-of-businesses"},{"title":"Get Hierarchy","openapi":"api/openapi.yaml GET /v1/business/{businessId}/hierarchy","href":"/api/business/get-hierarchy-for-an-enterprise"},{"title":"Get Hierarchy v2","openapi":"api/openapi.yaml GET /v2/business/hierarchy/info","href":"/api/business/get-hierarchy-v2"},{"title":"Update Hierarchy","openapi":"api/openapi.yaml POST /v1/business/business-hierarchy/location/update-mapping/{businessId}","href":"/api/business/update-hierarchy"},{"title":"Get Custom card details","openapi":"api/openapi.yaml GET /v1/business/{businessNumber}/profile/customcard","href":"/api/business/get-custom-card-details"},{"title":"Manage Custom card","openapi":"api/openapi.yaml PUT /v1/business/public/card/{cardId}","href":"/api/business/update-custom-card"},{"title":"Manage Custom card","openapi":"api/openapi.yaml DELETE /v1/business/public/card/{cardId}","href":"/api/business/delete-custom-card"},{"title":"Get Timezone List","openapi":"api/openapi.yaml GET /v1/business/{businessNumber}/timezones","href":"/api/business/get-timezone-list"},{"title":"Get Birdeye Impressions","openapi":"api/openapi.yaml POST /v1/business/{businessNumber}/birdeye/impressions","href":"/api/business/get-birdeye-impressions"}]},{"group":"Custom Fields","icon":"sliders","pages":[{"title":"Custom Fields","href":"/api/custom-fields/overview"},{"title":"Create Custom Fields","openapi":"api/openapi.yaml POST /v1/business/public/custom-fields/create","href":"/api/custom-fields/create"},{"title":"Update Custom Fields","openapi":"api/openapi.yaml PUT /v1/business/public/custom-fields/update/{fieldId}","href":"/api/custom-fields/update"},{"title":"Get Custom Fields","openapi":"api/openapi.yaml GET /v1/business/public/custom-fields/get/{fieldId}?locationBizNumber={locationBizNumber}","href":"/api/custom-fields/get"},{"title":"Get Custom Fields List","openapi":"api/openapi.yaml POST /v1/business/public/custom-fields/getList?locationBizNumber={locationBizNumber}","href":"/api/custom-fields/post"},{"title":"Delete Custom Fields","openapi":"api/openapi.yaml DELETE /v1/business/public/custom-fields/delete/{fieldId}","href":"/api/custom-fields/delete"},{"title":"Associate Custom Fields","openapi":"api/openapi.yaml PUT /v1/business/public/custom-fields/associate","href":"/api/custom-fields/associate"},{"title":"Create Custom card","openapi":"api/openapi.yaml POST /v1/business/public/card","href":"/api/custom-fields/create-custom-card"}]},{"group":"User","icon":"user","pages":[{"title":"User","href":"/api/user/overview"},{"title":"Signup","openapi":"api/openapi.yaml POST /v1/user/signup/v2","href":"/api/user/create-user"},{"title":"Update User","openapi":"api/openapi.yaml PUT /v1/user/updateUser","href":"/api/user/update-user"},{"title":"Delete","openapi":"api/openapi.yaml DELETE /v1/user/remove","href":"/api/user/delete-a-user"},{"title":"Password","openapi":"api/openapi.yaml POST /v1/user/forgotpassword","href":"/api/user/forgot-password"},{"title":"Get","openapi":"api/openapi.yaml GET /v1/user/details","href":"/api/user/get-details-of-a-user"}]},{"group":"Reviews","icon":"star","pages":[{"title":"Reviews","href":"/api/reviews/overview"},{"title":"Get","openapi":"api/openapi.yaml POST /v1/review/businessId/{businessId}","href":"/api/reviews/get-reviews"},{"title":"Get Review Responses","openapi":"api/openapi.yaml POST /v1/review/response","href":"/api/reviews/get-review-responses"},{"title":"Archived Get Reviews","openapi":"api/openapi.yaml POST /v1/review/archive/public","href":"/api/reviews/archived-get-reviews"},{"title":"Review Summary","openapi":"api/openapi.yaml GET /v1/review/businessid/{businessId}/summary","href":"/api/reviews/get-reviews-summary"},{"title":"Review Reply","openapi":"api/openapi.yaml PUT /v1/review/reply/business/{businessNumber}/review/{reviewId}","href":"/api/reviews/post-review-reply"},{"title":"Create Tags","openapi":"api/openapi.yaml POST /v1/tag","href":"/api/reviews/create-tags"},{"title":"Delete Tag","openapi":"api/openapi.yaml DELETE /v1/tag/{tagname}","href":"/api/reviews/delete-a-tag"},{"title":"Fetch Tags","openapi":"api/openapi.yaml GET /v1/tag/all","href":"/api/reviews/get-all-tags"},{"title":"Search reviews and assign tags","openapi":"api/openapi.yaml POST /v1/tag/add/review","href":"/api/reviews/assign-tags-to-filtered-reviews"},{"title":"Search reviews and remove tags","openapi":"api/openapi.yaml POST /v1/tag/remove/review","href":"/api/reviews/remove-tags-from-filtered-reviews"},{"title":"Remove tags from all reviews","openapi":"api/openapi.yaml POST /v1/tag/remove/all/review","href":"/api/reviews/remove-particular-tags-from-all-reviews"}]},{"group":"Contact","icon":"address-book","pages":[{"title":"Contact","href":"/api/contact/overview"},{"title":"Create or Update Contact","openapi":"api/openapi.yaml POST /v1/customer-v2/external/saveCustomer","href":"/api/contact/create-or-update-contact"},{"title":"Get Contact","openapi":"api/openapi.yaml POST /v1/customer-v2/external/getCustomer","href":"/api/contact/get-contact"},{"title":"Delete Contact","openapi":"api/openapi.yaml POST /v1/customer-v2/external/deleteCustomer","href":"/api/contact/delete-contact"},{"title":"Check in","openapi":"api/openapi.yaml POST /v1/customer/checkin","href":"/api/contact/customer-checkin"},{"title":"Activity log","openapi":"api/openapi.yaml GET /v1/customer/history/{customerId}","href":"/api/contact/customer-activity-log"},{"title":"Delete Customer","openapi":"api/openapi.yaml DELETE /v1/customer/id/{customerId}","href":"/api/contact/customer-delete"},{"title":"Subscribe/Unsubscribe Customer","openapi":"api/openapi.yaml POST /v1/customer-v2/change-permission","href":"/api/contact/subscribe-unsubscribe-customer"},{"title":"Contacts list","openapi":"api/openapi.yaml POST /v2/customer/list","href":"/api/contact/contact"},{"title":"Customer or Lead list","openapi":"api/openapi.yaml POST /v1/contact/details","href":"/api/contact/customer-or-lead-list"},{"title":"Contact Us","openapi":"api/openapi.yaml POST /v1/contactUs/{businessId}","href":"/api/contact/contact-us-request"},{"title":"Get opt-out Contacts","openapi":"api/openapi.yaml POST /v1/contact/{businessId}/update-feed","href":"/api/contact/get-opt-out-contact-data"}]},{"group":"Contact V2","icon":"address-card","pages":[{"title":"Contact V2","href":"/api/contact-v2/overview"},{"title":"Upsert Contact","openapi":"api/openapi.yaml POST /v1/contact/external/preferences/saveCustomer","href":"/api/contact-v2/upsert-contact"},{"title":"Retrieve Contact","openapi":"api/openapi.yaml POST /v1/contact/external/preferences/getCustomer","href":"/api/contact-v2/retrieve-contact"},{"title":"Customer Check in","openapi":"api/openapi.yaml POST /v1/contact/external/preferences/checkin","href":"/api/contact-v2/customer-checkin"},{"title":"Update Communication Preferences","openapi":"api/openapi.yaml POST /v1/contact/external/preferences/change-permission","href":"/api/contact-v2/update-communication-preferences"},{"title":"Retrieve Opted-Out Contacts","openapi":"api/openapi.yaml POST /v1/contact/external/preferences/update-feed","href":"/api/contact-v2/retrieve-opted-out-contacts"}]},{"group":"Campaign","icon":"bullhorn","pages":[{"title":"Campaign","href":"/api/campaign/overview"},{"title":"Fetch Request URL","openapi":"api/openapi.yaml POST /v1/campaign/external/campaign-request-url","href":"/api/campaign/fetch-request-url"},{"title":"Set Defaullt Review Sources","openapi":"api/openapi.yaml POST /v1/campaign/external/default-review-sources","href":"/api/campaign/set-defaullt-review-sources"}]},{"group":"Aggregation","icon":"layer-group","pages":[{"title":"Aggregation","href":"/api/aggregation/overview"},{"title":"Get source list","openapi":"api/openapi.yaml GET /v1/aggregation/business/{businessId}","href":"/api/aggregation/get-business-aggregation-sources"},{"title":"Get Source List-lite","openapi":"api/openapi.yaml GET /v1/survey/reviewsites-alias","href":"/api/aggregation/get-all-aggregation-source"},{"title":"Add Aggregation Link","openapi":"api/openapi.yaml POST /v1/aggregation/business/{business_id}","href":"/api/aggregation/add-aggregation-url"},{"title":"Delete","openapi":"api/openapi.yaml DELETE /v1/aggregation/business/{businessID}/aggregation/{aggregationID}","href":"/api/aggregation/delete-aggregation-url"}]},{"group":"Report","icon":"chart-bar","pages":[{"title":"Report","href":"/api/report/overview"},{"title":"Dashboard","openapi":"api/openapi.yaml GET /v1/reports/smb","href":"/api/report/get-dashboard-data"},{"title":"Review conversion report","openapi":"api/openapi.yaml GET /v1/reports/business/analytics/email","href":"/api/report/get-review-conversion-report"},{"title":"Review and rating over time","openapi":"api/openapi.yaml POST /v1/reports/review/analytic/time","href":"/api/report/review-and-rating-over-time-report"},{"title":"Reviews \u0026 Rating By Location","openapi":"api/openapi.yaml POST /v1/reports/rating/location","href":"/api/report/reviews-rating-by-location-report"},{"title":"Review Count \u0026 Rating","openapi":"api/openapi.yaml POST /v1/review/report/count-by-rating/{BusinessId}","href":"/api/report/review-count-rating"},{"title":"Review Count \u0026 Rating By Employee","openapi":"api/openapi.yaml POST /v1/review/report/count-by-rating/employee/{BusinessId}","href":"/api/report/review-count-rating-by-employee"},{"title":"Insights Category Report by location","openapi":"api/openapi.yaml POST /v1/keywords/opmetric/location","href":"/api/report/insights-category-report-by-location-report"},{"title":"Competitive Ranking","openapi":"api/openapi.yaml POST /v2/competitive/ranking","href":"/api/report/competitive-ranking-report"},{"title":"NPS Over time","openapi":"api/openapi.yaml POST /v1/reports/nps/time/elst","href":"/api/report/nps-over-time-report"},{"title":"NPS By Location","openapi":"api/openapi.yaml POST /v1/reports/nps/location/elst","href":"/api/report/nps-by-location-report"},{"title":"Review By Source","openapi":"api/openapi.yaml POST /v1/reports/count/reviewsite","href":"/api/report/review-by-source-report"},{"title":"Visitor report","openapi":"api/openapi.yaml POST /v1/reports/count/visitors","href":"/api/report/visitor-report"},{"title":"Usage report","openapi":"api/openapi.yaml POST /v1/reports/usage","href":"/api/report/usage-report"},{"title":"Review Response Rate Over Time","openapi":"api/openapi.yaml POST /v1/review/report/response-rate/time/rate-over-time","href":"/api/report/review-response-rate-over-time"},{"title":"Review Response Rate By Location Overview","openapi":"api/openapi.yaml POST /v1/review/report/response-rate/by-location/overview","href":"/api/report/review-response-rate-by-location-overview"},{"title":"Average Response Time By Location","openapi":"api/openapi.yaml POST /v1/review/report/avg-response-time/by-location","href":"/api/report/average-response-time-by-location"},{"title":"Average Response Time Over Time","openapi":"api/openapi.yaml POST /v1/review/report/avg-response-time/time","href":"/api/report/average-response-time-over-time"}]},{"group":"Survey","icon":"clipboard-list","pages":[{"title":"Survey","href":"/api/survey/overview"},{"title":"Get","openapi":"api/openapi.yaml GET /v1/survey/{survey_id}","href":"/api/survey/get-survey"},{"title":"Submit","openapi":"api/openapi.yaml POST /v1/survey/{survey_id}/submit","href":"/api/survey/post-a-survey-response"},{"title":"List Responses","openapi":"api/openapi.yaml POST /v1/survey/ext/list/responses/{survey_id}","href":"/api/survey/list-responses-for-a-survey"},{"title":"Get Survey Usage by Location","openapi":"api/openapi.yaml POST /v1/survey/{surveyId}/usage/by-location","href":"/api/survey/get-survey-usage-by-location"},{"title":"Get All","openapi":"api/openapi.yaml GET /v1/survey/business/{business_id}/all","href":"/api/survey/get-all-surveys"},{"title":"Create Survey","openapi":"api/openapi.yaml POST /v1/survey/external/create/{businessId}","href":"/api/survey/create-survey"},{"title":"Update Settings","openapi":"api/openapi.yaml POST /v1/survey/{surveyId}/settings/update","href":"/api/survey/update-survey-settings"}]},{"group":"Business Media","icon":"photo-film","pages":[{"title":"Business Media","href":"/api/business-media/overview"},{"title":"Add Media","openapi":"api/openapi.yaml POST /v1/business/{businessNumber}/upload/media","href":"/api/business-media/add-media"},{"title":"Get Media","openapi":"api/openapi.yaml GET /v1/business/{businessNumber}/media/get","href":"/api/business-media/get-media"},{"title":"Update Media","openapi":"api/openapi.yaml PUT /v1/business/{businessNumber}/update/media/{mediaId}","href":"/api/business-media/update-media"},{"title":"Delete Media","openapi":"api/openapi.yaml DELETE /v1/business/{businessNumber}/media/delete","href":"/api/business-media/delete-media"}]},{"group":"Social","icon":"share-nodes","pages":[{"title":"Social","href":"/api/social/overview"},{"title":"Schedule Social Post","openapi":"api/openapi.yaml POST /v1/social/{accountNumber}/schedule","href":"/api/social/schedule-social-post"},{"title":"Edit scheduled Social Post","openapi":"api/openapi.yaml POST /v1/social/post/public/scheduled/edit/{accountNumber}","href":"/api/social/edit-scheduled-social-post"},{"title":"Edit published social Post","openapi":"api/openapi.yaml POST /v1/social/post/public/published/edit/{accountNumber}","href":"/api/social/edit-published-social-post"},{"title":"Delete public social Post","openapi":"api/openapi.yaml POST /v1/social/post/public/delete/{accountNumber}","href":"/api/social/delete-public-social-post"},{"title":"Track Social Post","openapi":"api/openapi.yaml GET /v1/social/{accountNumber}/post/track/{trackingId}","href":"/api/social/track-social-post"},{"title":"Social Open URL Performance Report","openapi":"api/openapi.yaml POST /v1/social/open-url/performance/report","href":"/api/social/social-open-url-performance-report"},{"title":"Upload Social Media","openapi":"api/openapi.yaml POST /v1/social/post/public/media/upload","href":"/api/social/upload-social-media"},{"title":"Track Social Media Upload","openapi":"api/openapi.yaml GET /v1/social/post/public/media/track/{batch_id}","href":"/api/social/track-social-media-upload"}]},{"group":"Employee","icon":"user-tie","pages":[{"title":"Get","openapi":"api/openapi.yaml GET /v1/employee/{businessId}","href":"/api/employee/get-details-of-employees"}]},{"group":"Conversation","icon":"comments","pages":[{"title":"Conversation","description":null,"href":"/api/conversation/overview"},{"title":"List Conversations","openapi":"api/openapi.yaml POST /v1/messenger/export","href":"/api/conversation/list-conversations"}]},{"group":"Subscription","icon":"bell","pages":[{"title":"Subscription","description":null,"href":"/api/subscription/overview"},{"title":"Subscribe","openapi":"api/openapi.yaml POST /v1/subscriptions/subscribe","href":"/api/subscription/create-subscription"},{"title":"List","openapi":"api/openapi.yaml GET /v1/subscriptions/list","href":"/api/subscription/list-subscriptions"},{"title":"Unsubscribe","openapi":"api/openapi.yaml GET /v1/subscriptions/unsubscribe/{subscriptionId}","href":"/api/subscription/unsubscribe-subscription"}]},{"group":"Webhook","icon":"webhook","pages":[{"title":"Webhook","href":"/api/webhook/overview"},{"title":"List webhook events","openapi":"api/openapi.yaml GET /v1/messenger/webhook/event","href":"/api/webhook/get-events"},{"title":"Create webhook subscription","openapi":"api/openapi.yaml POST /v1/messenger/subscribe/webhook/event","href":"/api/webhook/create-webhook-subscription"}]},{"group":"Competitor","icon":"trophy","pages":[{"title":"Competitor","href":"/api/competitor/overview"},{"title":"Competitor of Enterprise Business","openapi":"api/openapi.yaml GET /v1/business/{EnterpriseBusinessNumber}/child","href":"/api/competitor/get-competitor-business"},{"title":"Child Business of Competitor","openapi":"api/openapi.yaml GET /v1/business/{EnterpriseCompetitorBusinessId}/child","href":"/api/competitor/get-competitor-child-business"},{"title":"Get Competitors","openapi":"api/openapi.yaml GET /v1/business/{businessId}/competitors","href":"/api/competitor/get-business-competitors"},{"title":"Create Competitor Enterprise","openapi":"api/openapi.yaml POST /v1/signup/competitor/{businessNumber}","href":"/api/competitor/create-new-competitor-enterprise"},{"title":"Create Child Business","openapi":"api/openapi.yaml POST /v1/signup/competitor/{businessId}","href":"/api/competitor/create-new-child-business-in-competitor-enterprise"},{"title":"Add Aggregation Link","openapi":"api/openapi.yaml POST /v1/aggregation/competitor/{compAccountId}/{businessNumber}","href":"/api/competitor/add-new-competitor-aggregation-url"},{"title":"Get Competitor Review","openapi":"api/openapi.yaml POST /v1/review/businessId/{CompetitorEnterpriseBusinessId}","href":"/api/competitor/get-competitor-reviews"},{"title":"Competitive Insight Category","openapi":"api/openapi.yaml POST /v1/competitors/competitive-insight/categories/{businessNumber}","href":"/api/competitor/get-score"},{"title":"Competitive Insight Themes","openapi":"api/openapi.yaml POST /v1/competitors/competitive-insight/themes/{businessNumber}","href":"/api/competitor/get-theme-statistics"},{"title":"Competitive Insight Keywords","openapi":"api/openapi.yaml POST /v1/competitors/competitive-insight/keywords/{businessNumber}","href":"/api/competitor/get-keyword-statistics"}]},{"group":"Competitor AI","icon":"robot","pages":[{"title":"Competitor AI","href":"/api/competitor-ai/overview"},{"title":"Retrieve Competitor Reviews","openapi":"api/openapi.yaml POST /v1/competitors/review","href":"/api/competitor-ai/retrieve-competitor-reviews"},{"title":"Retrieve Competitor Review Metrics","openapi":"api/openapi.yaml POST /v1/competitors/review/metrics","href":"/api/competitor-ai/retrieve-competitor-review-metrics"}]},{"group":"Insight AI","icon":"lightbulb","pages":[{"title":"Insight AI","href":"/api/insight-ai/overview"},{"title":"Insight Experience Score Benchmark","openapi":"api/openapi.yaml POST /v1/insight/experience/scoreBenchmark","href":"/api/insight-ai/get-insight-experience-score-benchmark"},{"title":"Insight Experience Location Info","openapi":"api/openapi.yaml POST /v1/insight/experience/locationInfo","href":"/api/insight-ai/get-insight-experience-location-info"},{"title":"Insight Experience Location Info Rank","openapi":"api/openapi.yaml POST /v1/insight/experience/locationInfo/rank","href":"/api/insight-ai/get-insight-experience-location-info-rank"},{"title":"Insight Experience Over Time","openapi":"api/openapi.yaml POST /v1/insight/experience/over-time","href":"/api/insight-ai/get-insight-experience-over-time"},{"title":"Insight Sentiment Score Benchmark","openapi":"api/openapi.yaml POST /v1/insight/sentiment/scoreBenchmark","href":"/api/insight-ai/get-insight-sentiment-score-benchmark"},{"title":"Insight Sentiment Location Info","openapi":"api/openapi.yaml POST /v1/insight/sentiment/locationInfo","href":"/api/insight-ai/get-insight-sentiment-location-info"},{"title":"Insight Sentiment Location Info Rank","openapi":"api/openapi.yaml POST /v1/insight/sentiment/locationInfo/rank","href":"/api/insight-ai/get-insight-sentiment-location-info-rank"},{"title":"Insight Sentiment Over Time","openapi":"api/openapi.yaml POST /v1/insight/sentiment/over-time","href":"/api/insight-ai/get-insight-sentiment-over-time"},{"title":"Insight Sentiment Category","openapi":"api/openapi.yaml POST /v1/insight/sentiment/category","href":"/api/insight-ai/get-insight-sentiment-category"},{"title":"Insight Reputation Score Benchmark","openapi":"api/openapi.yaml POST /v1/insight/reputation/scoreBenchmark","href":"/api/insight-ai/get-insight-reputation-score-benchmark"},{"title":"Insight Reputation Location Info","openapi":"api/openapi.yaml POST /v1/insight/reputation/locationInfo","href":"/api/insight-ai/get-insight-reputation-location-info"},{"title":"Insight Reputation Location Info Rank","openapi":"api/openapi.yaml POST /v1/insight/reputation/locationInfo/rank","href":"/api/insight-ai/get-insight-reputation-location-info-rank"},{"title":"Insight Reputation Over Time","openapi":"api/openapi.yaml POST /v1/insight/reputation/over-time","href":"/api/insight-ai/get-insight-reputation-over-time"},{"title":"Insight Reputation Source","openapi":"api/openapi.yaml POST /v1/insight/reputation/source","href":"/api/insight-ai/get-insight-reputation-source"}]},{"group":"Google Q\u0026A","icon":"circle-question","pages":[{"title":"Google Q\u0026A","href":"/api/google-q-a/overview"},{"title":"Create Question","openapi":"api/openapi.yaml POST /v1/qna/question/create","href":"/api/google-q-a/create-question"},{"title":"Create Answer","openapi":"api/openapi.yaml POST /v1/qna/answer/create","href":"/api/google-q-a/create-answer"},{"title":"Update Question","openapi":"api/openapi.yaml PUT /v1/qna/question/update","href":"/api/google-q-a/update-question"},{"title":"Update Answer","openapi":"api/openapi.yaml PUT /v1/qna/answer/update","href":"/api/google-q-a/update-answer"},{"title":"Delete Question","openapi":"api/openapi.yaml POST /v1/qna/question/delete","href":"/api/google-q-a/delete-question"},{"title":"Delete Answer","openapi":"api/openapi.yaml POST /v1/qna/answer/delete","href":"/api/google-q-a/delete-answer"},{"title":"Delete All Questions and Answers","openapi":"api/openapi.yaml DELETE /v1/qna/question/deleteAll","href":"/api/google-q-a/delete-all-questions-and-answers"},{"title":"Get All Questions and Answers","openapi":"api/openapi.yaml POST /v1/qna/get","href":"/api/google-q-a/get-all-questions-and-answers"},{"title":"Get All Unanswered Q\u0026A","openapi":"api/openapi.yaml POST /v1/qna/unanswered/get","href":"/api/google-q-a/get-all-unanswered-questions-and-answers"}]},{"group":"Google Services","icon":"globe","pages":[{"title":"Google Services","href":"/api/google-services/overview"},{"title":"Create Service","openapi":"api/openapi.yaml POST /v1/google-services/service/create","href":"/api/google-services/create-service"},{"title":"Get All Services","openapi":"api/openapi.yaml POST /v1/google-services/services","href":"/api/google-services/get-all-services"},{"title":"Update Service","openapi":"api/openapi.yaml POST /v1/google-services/service/update","href":"/api/google-services/update-service"},{"title":"Delete Services","openapi":"api/openapi.yaml POST /v1/google-services/service/delete","href":"/api/google-services/delete-services"},{"title":"Get Location Mapping","openapi":"api/openapi.yaml GET /v1/google-services/service/location-mapping","href":"/api/google-services/get-location-mapping"},{"title":"Update Location Mapping","openapi":"api/openapi.yaml POST /v1/google-services/services/location-mapping","href":"/api/google-services/update-location-mapping"}]},{"group":"FAQ","icon":"circle-question","pages":[{"title":"FAQ","href":"/api/faq/overview"},{"title":"Get All QnA","openapi":"api/openapi.yaml POST /v1/quero/external/get-all-qna","href":"/api/faq/get-all-qna"}]},{"group":"Listing","icon":"map-pin","pages":[{"title":"Listing","href":"/api/listing/overview"},{"title":"Fix Listing","openapi":"api/openapi.yaml POST /v1/listing/fix","href":"/api/listing/fix-listing"},{"title":"Get Location Status Report","openapi":"api/openapi.yaml GET /v1/listing/status/location","href":"/api/listing/get-location-status-report"},{"title":"Listings Insights","openapi":"api/openapi.yaml POST /v1/listing/insights","href":"/api/listing/listings-insights"},{"title":"Listings Insights Datapoints","openapi":"api/openapi.yaml POST /v1/listing/report/{reportType}/datapoints","href":"/api/listing/listings-insights-datapoints"},{"title":"Get GMB Attributes","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/gmb-attributes-list","href":"/api/listing/get-gmb-attributes"},{"title":"Get Apple Attributes","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/apple-location-attributes-list","href":"/api/listing/get-apple-attributes"},{"title":"Get Apple Action Links","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/apple-action-links","href":"/api/listing/get-apple-action-links"},{"title":"Get Category List","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/category-list","href":"/api/listing/get-category-list"},{"title":"Create Listing","openapi":"api/openapi.yaml POST /v1/listing/{businessNumber}/create","href":"/api/listing/create-listing"},{"title":"Update Listing","openapi":"api/openapi.yaml PUT /v1/listing/{businessNumber}/update","href":"/api/listing/update-listing"},{"title":"Get Listing","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/get","href":"/api/listing/get-listing"},{"title":"Get More Hours Type","openapi":"api/openapi.yaml GET /v1/listing/{businessNumber}/more-hours-type","href":"/api/listing/get-more-hours-type"},{"title":"Get Google Keywords Count","openapi":"api/openapi.yaml POST /v1/listing/{businessNumber}/gmb/keywords","href":"/api/listing/get-google-keywords-count"},{"title":"Deactivate Listing","openapi":"api/openapi.yaml POST /v1/listing/{businessNumber}/deactivate","href":"/api/listing/deactivate-listing"},{"title":"Retrieve Menu Details","openapi":"api/openapi.yaml POST /v1/listing/menu-details","href":"/api/listing/retrieve-menu-details"},{"title":"Get Hotel Attributes","openapi":"api/openapi.yaml GET /v1/listing/get/hotel-attributes","href":"/api/listing/get-hotel-attributes"}]},{"group":"GMB Products","icon":"bag-shopping","pages":[{"title":"GMB Products","href":"/api/gmb-products/overview"},{"title":"Onboard Google Merchant Account","openapi":"api/openapi.yaml POST /v1/listing/public/product/setup/googleMerchant","href":"/api/gmb-products/onboard-google-merchant-account"},{"title":"Create Product Listing","openapi":"api/openapi.yaml POST /v1/listing/public/product","href":"/api/gmb-products/create-product-listing"},{"title":"Update Product Listing","openapi":"api/openapi.yaml PUT /v1/listing/public/product/{productId}","href":"/api/gmb-products/update-product-listing"},{"title":"Get Product Listing","openapi":"api/openapi.yaml GET /v1/listing/public/product/{productIdentifier}","href":"/api/gmb-products/get-product-listing"},{"title":"Delete Product Listings","openapi":"api/openapi.yaml POST /v1/listing/public/product/deleteProduct","href":"/api/gmb-products/delete-product-listings"},{"title":"Get List Product Listing","openapi":"api/openapi.yaml POST /v1/listing/public/product/getList","href":"/api/gmb-products/get-list-product-listing"},{"title":"Add Products On a Location","openapi":"api/openapi.yaml POST /v1/listing/public/product/addProduct","href":"/api/gmb-products/add-products-on-a-location"},{"title":"Remove Products On a Location","openapi":"api/openapi.yaml POST /v1/listing/public/product/removeProduct","href":"/api/gmb-products/remove-products-on-a-location"}]},{"group":"AI Search","icon":"magnifying-glass","pages":[{"title":"AI Search","href":"/api/search-ai/overview"},{"title":"Get AI Search Configuration","openapi":"api/openapi.yaml GET /v1/listing/searchAi/public/account-setup","href":"/api/search-ai/get-search-ai-configuration"},{"title":"Get AI Search Available Runs","openapi":"api/openapi.yaml GET /v1/listing/searchAi/public/available-runs","href":"/api/search-ai/get-search-ai-available-runs"},{"title":"Get AI Search Citations","openapi":"api/openapi.yaml POST /v1/listing/searchAi/public/citations","href":"/api/search-ai/get-search-ai-citations"},{"title":"Get AI Search Businesses","openapi":"api/openapi.yaml POST /v1/listing/searchAi/public/business","href":"/api/search-ai/get-search-ai-businesses"},{"title":"Get Accuracy Report","openapi":"api/openapi.yaml POST /v1/listing/searchAi/public/aio-details?page-size=100\u0026start-index=0","href":"/api/search-ai/get-accuracy-report"},{"title":"Get Sentiment Report","openapi":"api/openapi.yaml POST /v1/listing/searchAi/public/swot-details?page-size=100\u0026start-index=0","href":"/api/search-ai/get-sentiment-report"}]},{"group":"Ticketing","icon":"ticket","pages":[{"title":"Ticketing","href":"/api/ticketing/overview"},{"title":"Create ticket","openapi":"api/openapi.yaml PUT /v1/ticket/{businessNumber}/create-ticket","href":"/api/ticketing/create-ticket"},{"title":"Add Ticket Comments","openapi":"api/openapi.yaml POST /v1/ticket/{businessNumber}/comment-activity","href":"/api/ticketing/add-ticket-comments"},{"title":"Update ticket","openapi":"api/openapi.yaml PUT /v1/ticket/{businessNumber}/update","href":"/api/ticketing/update-ticket"},{"title":"Get All Ticket Data","openapi":"api/openapi.yaml POST /v1/ticket/{businessNumber}/get/all?","href":"/api/ticketing/get-all-ticket-data"}]},{"group":"Integration","icon":"plug","pages":[{"title":"Integration","href":"/api/integration/overview"},{"title":"Add Business Integration Mapping","openapi":"api/openapi.yaml PUT /v1/integrations/add/businessintegrationmapping","href":"/api/integration/add-locations"}]}]}]}]},"basePath":"","title":"List Conversations - Birdeye Developer Portal","buildId":"dpl_77Hw7ZuAABM8E3WMbYAf2ohQCr3v","deploymentId":"dpl_77Hw7ZuAABM8E3WMbYAf2ohQCr3v","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CVpqyvFO.js","utils-vpweLD0v.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BIOodqb0.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B1LM3qmu.js","snippetPresets-C5xK0GtN.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CCsxLnQl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C2-WKG22.js","shallow-SdoLUC-q.js","getApiPlaygroundDisplay-BnI8L2hB.js","CodeSnippet-D5M8NCHI.js","CodeSnippets-CXRO8Uom.js","Page-CN9QbZiA.js","getPastedJson-CrfHEdRt.js","icon-Cr8AyUnW.js","MethodPill-J_Cs0kNw.js","DuplicateIcon-DrMboxGw.js","createIcon-B4CIWVbU.js","DynamicMarkdown-D9cdbgj9.js","SectionHeading-BO4CouT0.js","axios-vUo_bRtp.js","Markdown-L1m1-PSi.js","clsx-rIpTdK8h.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-ptfS1uB_.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-D31Sm3f9.js"]}