A workspace API key, created in workspace settings and sent as Authorization: Bearer op_live_…. Session cookies are not accepted. Scopes: signals:read, accounts:read, listeners:read, listeners:analyse, pipeline:read, pipeline:write, collections:write, export:read.
The listener, plus schedulerState read live from the queue. That can disagree with the stored nextRunAt beside it, and when it does the queue is right.
One listener with its full configuration, plus the live state of its repeat schedule read from the queue rather than from the database.
What it listens for. market watches conversations, rivals watches complaints about named competitors, places reads the reviews of local prospects. Derived from objective at creation.
The vendor communities a vendor_community listener watches, from the curated registry. Required when that source is selected and meaningless otherwise — the source is pinned to these hosts rather than to one domain of its own.
Set when the listener was paused because the subscription lapsed, rather than because somebody chose to pause it. A separate marker and not a status, so resubscribing restores exactly the set billing stopped.
What this listener's owner sells, for an outreach draft to pitch from. capabilities is a closed list and the draft prompt treats it as one: a model asked to pitch a product it knows only by name invents features, and an invented feature in a first message is a lie told to a stranger in public under the company's name.
Who else the market is paying, and what they say when it disappoints them. painVocabulary is separate from the plan's includeKeywords on purpose: a review reading "rude staff, an hour on hold" shares no keyword with "scheduling software", so the on-topic words for this mode have to be the words of the complaint rather than of the product.
What this listener sends to the board by itself. Absent means never configured, which is the same as disabled: a listener that predates this must not start opening deals because a deploy happened.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Open Pulse","description":"Open Pulse finds public conversations that are evidence somebody has a budgeted problem, and scores each one against what you sell.","colors":{"primary":"#446317","light":"#C6E868","dark":"#446317"},"logo":{"light":"https://mintcdn.com/open-pulse/2lhu05m2dSiIFlof/logo/light.svg?fit=max\u0026auto=format\u0026n=2lhu05m2dSiIFlof\u0026q=85\u0026s=a403a5531b58270dadb02f1862164683","dark":"https://mintcdn.com/open-pulse/2lhu05m2dSiIFlof/logo/dark.svg?fit=max\u0026auto=format\u0026n=2lhu05m2dSiIFlof\u0026q=85\u0026s=518fb339322cbf15840dff18d8da3847"},"favicon":"https://mintcdn.com/open-pulse/P8LbHWHUpEv-R7cz/favicon.svg?fit=max\u0026auto=format\u0026n=P8LbHWHUpEv-R7cz\u0026q=85\u0026s=4f377ad25662c68808d611467995875a","navbar":{"links":[{"href":"https://openpulse.cloud/sign-in","label":"Sign in"}],"primary":{"type":"button","label":"Get started","href":"https://openpulse.cloud/pricing"}},"footer":{"links":[{"header":"Open Pulse","items":[{"label":"Product","href":"https://openpulse.cloud"},{"label":"Pricing","href":"https://openpulse.cloud/pricing"},{"label":"Developers","href":"https://openpulse.cloud/developers"}]},{"header":"Follow","items":[{"label":"TikTok","href":"https://www.tiktok.com/@getopenpulse"},{"label":"X","href":"https://x.com/getopenpulse"},{"label":"Instagram","href":"https://www.instagram.com/getopenpulse"}]}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"open-pulse","hasAudioNarration":false,"actualSubdomain":"open-pulse","customDomains":["docs.openpulse.cloud"],"gitSource":{"type":"github","owner":"optiqlabs","repo":"open-pulse","deployBranch":"develop","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae17d044eb6f5188cc094f4","collectionId":"88fa9485-d841-4c17-9d70-2fa1eaff8c23","liveDeploymentHistoryId":"6ae17d044eb6f5188cc094f4","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae17d044eb6f5188cc094f4","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Guides","count":22},{"language":"default","tag":"API Reference","count":20},{"language":"default","tag":"Integrations","count":5},{"language":"default","tag":"Pipeline","count":5},{"language":"default","tag":"Selling Surfaces","count":4},{"language":"default","tag":"Results","count":4},{"language":"default","tag":"Working Leads","count":3},{"language":"default","tag":"Delivering \u0026 Managing","count":3},{"language":"default","tag":"Listeners \u0026 Runs","count":3},{"language":"default","tag":"Exports","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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/listeners/get-one-listener","slug":"/api-reference/listeners/get-one-listener","pageMetadata":{"title":"Get one listener","description":"One listener with its full configuration — keywords, exclusions, per-source queries, sensitivity and schedule — plus its current scheduler state.\n\nAn id belonging to another workspace is indistinguishable from one that does not exist: both answer 404.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/listeners/{id}","href":"/api-reference/listeners/get-one-listener","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"One listener with its full configuration — keywords, exclusions, per-source queries, sensitivity and schedule — plus its current scheduler state.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"An id belonging to another workspace is indistinguishable from one that does not exist: both answer 404.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get one listener","description":"One listener with its full configuration — keywords, exclusions, per-source queries, sensitivity and schedule — plus its current scheduler state.\n\nAn id belonging to another workspace is indistinguishable from one that does not exist: both answer 404.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/listeners/{id}","href":"/api-reference/listeners/get-one-listener","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getV1ListenersById","summary":"Get one listener","description":"One listener with its full configuration — keywords, exclusions, per-source queries, sensitivity and schedule — plus its current scheduler state.\n\nAn id belonging to another workspace is indistinguishable from one that does not exist: both answer 404.","tags":["listeners"],"security":["f989bd12-5923-4e83-b18c-ab3fda03f8a6"],"parameters":["64eb2bb6-561f-4f28-ae2d-e4006151a910"],"responses":{"200":"d24fdfab-7e77-47bc-8945-e335f5db34b7","401":"5dd64a34-6386-4e99-89e1-b7235c48957e","403":"e3746660-ffad-4544-aa58-a353b999b778","404":"de982680-5ae1-4ee3-94ce-d24cebbeb6fa","429":"5a920ae2-2831-49cf-80e7-566bffd4d0f3"},"method":"get","type":"path","servers":["15b4899c-a482-4812-8f0c-fad24a079ee3"],"path":"/v1/listeners/{id}","baseUrlOptions":["https://api.openpulse.cloud"],"title":"Get one listener","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"64eb2bb6-561f-4f28-ae2d-e4006151a910":{"name":"id","in":"path","description":"The id of the resource.","required":true,"schema":{"type":"string","isRequired":true,"description":"The id of the resource.","uniqueKey":"","typeLabel":"string"}}},"responses":{"d24fdfab-7e77-47bc-8945-e335f5db34b7":{"description":"The listener, plus `schedulerState` read live from the queue. That can disagree with the stored `nextRunAt` beside it, and when it does the queue is right.","content":{"application/json":{"schema":{"type":"object","description":"One listener with its full configuration, plus the live state of its repeat schedule read from the queue rather than from the database.","required":["id","orgId","createdBy","companyName","mode","objective","sources","schedule","lookbackHours","status","generatedKeywords","createdAt","schedulerState"],"properties":{"id":{"type":"string","description":"Stable identifier.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"orgId":{"type":"string","description":"The workspace this belongs to (`org_…`).","isRequired":true,"uniqueKey":"orgId","typeLabel":"string"},"createdBy":{"type":"string","description":"Clerk user id of whoever created it.","isRequired":true,"uniqueKey":"createdBy","typeLabel":"string"},"companyName":{"type":"string","description":"The company the listener searches on behalf of.","isRequired":true,"uniqueKey":"companyName","typeLabel":"string"},"mode":{"type":"string","enum":["market","rivals","places"],"description":"What it listens for. `market` watches conversations, `rivals` watches complaints about named competitors, `places` reads the reviews of local prospects. Derived from `objective` at creation.","isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"objective":{"type":"string","enum":["find_customers","find_competitors","find_partnerships","find_dissatisfaction","find_local_prospects","custom"],"description":"What it is for, as the wizard asked.","isRequired":true,"uniqueKey":"objective","typeLabel":"enum\u003cstring>"},"sources":{"type":"array","items":{"type":"string","enum":["x","linkedin","facebook","reddit","hackernews","linkedin_jobs","indeed","ashby","greenhouse","lever","google_reviews","g2","trustpilot","youtube","vendor_community"],"description":"A platform.","uniqueKey":"sources.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Which platforms each run searches.","isRequired":true,"uniqueKey":"sources","typeLabel":"enum\u003cstring>[]"},"schedule":{"type":"string","description":"Cron expression. When runs happen.","isRequired":true,"uniqueKey":"schedule","typeLabel":"string"},"lookbackHours":{"type":"integer","description":"How far back each run looks for conversations.","minimum":1,"isRequired":true,"uniqueKey":"lookbackHours","typeLabel":"integer"},"status":{"type":"string","enum":["draft","analysing","active","paused","error"],"description":"`draft` and `analysing` precede the first run; `error` means the last run failed.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"generatedKeywords":{"type":"array","items":{"type":"string","description":"A keyword.","uniqueKey":"generatedKeywords.items.[INDEX]","typeLabel":"string"},"description":"The keyword list the crawl produced.","isRequired":true,"uniqueKey":"generatedKeywords","typeLabel":"string[]"},"createdAt":{"type":"string","format":"date-time","description":"When it was created. The pagination sort key.","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"schedulerState":{"type":"object","description":"What the queue says, which can disagree with `nextRunAt` above: that field is a stored copy and this is the live answer.","required":["active"],"properties":{"active":{"type":"boolean","description":"Whether a repeat job is actually registered.","isRequired":true,"uniqueKey":"schedulerState.active","typeLabel":"boolean"},"pattern":{"type":"string","description":"The cron expression the queue holds.","uniqueKey":"schedulerState.pattern","typeLabel":"string"},"nextRunAt":{"type":"string","format":"date-time","description":"When the queue will next fire it.","uniqueKey":"schedulerState.nextRunAt","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"schedulerState","typeLabel":"object"},"customObjective":{"type":"string","description":"Free text, when `objective` is `custom`.","uniqueKey":"customObjective","typeLabel":"string"},"website":{"type":"string","description":"The site the plan was generated from.","format":"uri","uniqueKey":"website","typeLabel":"string\u003curi>"},"description":{"type":"string","description":"What the business does, as the owner described it.","uniqueKey":"description","typeLabel":"string"},"minRelevanceScore":{"type":"integer","description":"Classified candidates below this are rejected rather than stored.","minimum":0,"maximum":100,"uniqueKey":"minRelevanceScore","typeLabel":"integer"},"sensitivity":{"type":"string","enum":["strict","balanced","broad"],"description":"The friendly way to pick a bar. `minRelevanceScore` wins when both are set, so a workspace that tuned the number by hand keeps it.","uniqueKey":"sensitivity","typeLabel":"enum\u003cstring>"},"maxRating":{"type":"integer","description":"Reviews above this many stars never reach the classifier.","minimum":1,"maximum":5,"uniqueKey":"maxRating","typeLabel":"integer"},"blockedDomains":{"type":"array","items":{"type":"string","description":"A hostname.","uniqueKey":"blockedDomains.items.[INDEX]","typeLabel":"string"},"description":"Domains never worth surfacing: your own site, known competitors.","uniqueKey":"blockedDomains","typeLabel":"string[]"},"communityHosts":{"type":"array","items":{"type":"string","description":"A community hostname.","uniqueKey":"communityHosts.items.[INDEX]","typeLabel":"string"},"description":"The vendor communities a `vendor_community` listener watches, from the curated registry. Required when that source is selected and meaningless otherwise — the source is pinned to these hosts rather than to one domain of its own.","uniqueKey":"communityHosts","typeLabel":"string[]"},"notifyEmails":{"type":"array","items":{"type":"string","description":"An address.","format":"email","uniqueKey":"notifyEmails.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"Who gets run summaries. Falls back to the workspace's list when absent.","uniqueKey":"notifyEmails","typeLabel":"string\u003cemail>[]"},"retiredReason":{"type":"string","description":"Why a listener was paused by something other than its owner, so \"why is this off?\" has an answer.","uniqueKey":"retiredReason","typeLabel":"string"},"billingSuspendedAt":{"type":"string","format":"date-time","description":"Set when the listener was paused because the subscription lapsed, rather than because somebody chose to pause it. A separate marker and not a status, so resubscribing restores exactly the set billing stopped.","uniqueKey":"billingSuspendedAt","typeLabel":"string\u003cdate-time>"},"searchPlan":{"type":"object","description":"What the listener searches for, generated from the crawl and editable after.","required":["summary","includeKeywords","excludeKeywords","queries"],"properties":{"summary":{"type":"string","description":"What the listener is looking for, in one paragraph.","isRequired":true,"uniqueKey":"searchPlan.summary","typeLabel":"string"},"includeKeywords":{"type":"array","items":{"type":"string","description":"A keyword.","uniqueKey":"searchPlan.includeKeywords.items.[INDEX]","typeLabel":"string"},"description":"The on-topic gate: a candidate sharing none of these is dropped before any model call.","isRequired":true,"uniqueKey":"searchPlan.includeKeywords","typeLabel":"string[]"},"excludeKeywords":{"type":"array","items":{"type":"string","description":"A keyword.","uniqueKey":"searchPlan.excludeKeywords.items.[INDEX]","typeLabel":"string"},"description":"Phrases that disqualify a candidate outright.","isRequired":true,"uniqueKey":"searchPlan.excludeKeywords","typeLabel":"string[]"},"queries":{"type":"array","items":{"type":"string","description":"A query.","uniqueKey":"searchPlan.queries.items.[INDEX]","typeLabel":"string"},"description":"Flat list kept for older listeners; run against every selected source.","isRequired":true,"uniqueKey":"searchPlan.queries","typeLabel":"string[]"},"plannedQueries":{"type":"array","items":{"type":"object","description":"A query aimed at the platforms whose phrasing it suits. Reddit rewards \"anyone using X\" phrasing and LinkedIn rewards topical phrasing; one set of queries against every platform is what produced most of the filler.","required":["text","sources"],"properties":{"text":{"type":"string","description":"The query itself.","isRequired":true,"uniqueKey":"searchPlan.plannedQueries.items.[INDEX].text","typeLabel":"string"},"sources":{"type":"array","items":{"type":"string","enum":["x","linkedin","facebook","reddit","hackernews","linkedin_jobs","indeed","ashby","greenhouse","lever","google_reviews","g2","trustpilot","youtube","vendor_community"],"description":"A platform.","uniqueKey":"searchPlan.plannedQueries.items.[INDEX].sources.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Where to run it.","isRequired":true,"uniqueKey":"searchPlan.plannedQueries.items.[INDEX].sources","typeLabel":"enum\u003cstring>[]"},"intent":{"type":"string","description":"What it is trying to catch, for the per-query yield report.","uniqueKey":"searchPlan.plannedQueries.items.[INDEX].intent","typeLabel":"string"}},"uniqueKey":"searchPlan.plannedQueries.items.[INDEX]","typeLabel":"object"},"description":"Per-source queries. **Preferred over `queries` when present.**","uniqueKey":"searchPlan.plannedQueries","typeLabel":"object[]"},"disabledQueries":{"type":"array","items":{"type":"string","description":"A query text.","uniqueKey":"searchPlan.disabledQueries.items.[INDEX]","typeLabel":"string"},"description":"Queries auto-disabled for never yielding a signal.","uniqueKey":"searchPlan.disabledQueries","typeLabel":"string[]"}},"uniqueKey":"searchPlan","typeLabel":"object"},"productProfile":{"type":"object","description":"What this listener's owner sells, for an outreach draft to pitch from. `capabilities` is a **closed list and the draft prompt treats it as one**: a model asked to pitch a product it knows only by name invents features, and an invented feature in a first message is a lie told to a stranger in public under the company's name.","required":["offering","audience","capabilities"],"properties":{"offering":{"type":"string","description":"One sentence: what the product is.","isRequired":true,"uniqueKey":"productProfile.offering","typeLabel":"string"},"audience":{"type":"string","description":"One sentence: who buys it.","isRequired":true,"uniqueKey":"productProfile.audience","typeLabel":"string"},"capabilities":{"type":"array","items":{"type":"string","description":"A short phrase, not a sentence.","uniqueKey":"productProfile.capabilities.items.[INDEX]","typeLabel":"string"},"description":"Three to five concrete things it does.","isRequired":true,"uniqueKey":"productProfile.capabilities","typeLabel":"string[]"},"differentiator":{"type":"string","description":"Why someone picks it over the obvious alternative, when the site says.","uniqueKey":"productProfile.differentiator","typeLabel":"string"}},"uniqueKey":"productProfile","typeLabel":"object"},"rivalProfile":{"type":"object","description":"Who else the market is paying, and what they say when it disappoints them. `painVocabulary` is separate from the plan's `includeKeywords` on purpose: a review reading \"rude staff, an hour on hold\" shares no keyword with \"scheduling software\", so the on-topic words for this mode have to be the words of the complaint rather than of the product.","required":["rivals","painVocabulary"],"properties":{"rivals":{"type":"array","items":{"type":"object","description":"One competitor a `rivals` listener watches.","required":["name","aliases","places"],"properties":{"name":{"type":"string","description":"The rival's name.","isRequired":true,"uniqueKey":"rivalProfile.rivals.items.[INDEX].name","typeLabel":"string"},"aliases":{"type":"array","items":{"type":"string","description":"An alias.","uniqueKey":"rivalProfile.rivals.items.[INDEX].aliases.items.[INDEX]","typeLabel":"string"},"description":"What people actually type: \"HubSpot\", \"hubspot\", \"HS\".","isRequired":true,"uniqueKey":"rivalProfile.rivals.items.[INDEX].aliases","typeLabel":"string[]"},"places":{"type":"array","items":{"type":"object","description":"A specific business on Google Maps, confirmed by a person in the wizard.","required":["placeId","name"],"properties":{"placeId":{"type":"string","description":"Google's stable identifier.","isRequired":true,"uniqueKey":"rivalProfile.rivals.items.[INDEX].places.items.[INDEX].placeId","typeLabel":"string"},"name":{"type":"string","description":"The business's name.","isRequired":true,"uniqueKey":"rivalProfile.rivals.items.[INDEX].places.items.[INDEX].name","typeLabel":"string"},"cid":{"type":"string","description":"Maps cluster id, which the reviews endpoint prefers.","uniqueKey":"rivalProfile.rivals.items.[INDEX].places.items.[INDEX].cid","typeLabel":"string"},"address":{"type":"string","description":"Its address, as Maps reports it.","uniqueKey":"rivalProfile.rivals.items.[INDEX].places.items.[INDEX].address","typeLabel":"string"},"rating":{"type":"number","description":"Its overall rating.","minimum":0,"maximum":5,"uniqueKey":"rivalProfile.rivals.items.[INDEX].places.items.[INDEX].rating","typeLabel":"number"},"reviewCount":{"type":"integer","description":"Its lifetime review count, which is not the number read.","minimum":0,"uniqueKey":"rivalProfile.rivals.items.[INDEX].places.items.[INDEX].reviewCount","typeLabel":"integer"}},"uniqueKey":"rivalProfile.rivals.items.[INDEX].places.items.[INDEX]","typeLabel":"object"},"description":"Its locations, when it has physical ones worth reading reviews of.","isRequired":true,"uniqueKey":"rivalProfile.rivals.items.[INDEX].places","typeLabel":"object[]"},"website":{"type":"string","description":"Its homepage.","format":"uri","uniqueKey":"rivalProfile.rivals.items.[INDEX].website","typeLabel":"string\u003curi>"},"provenance":{"type":"string","enum":["user","retrieved","model"],"description":"Where the name came from. Absent on listeners created before discovery existed.","uniqueKey":"rivalProfile.rivals.items.[INDEX].provenance","typeLabel":"enum\u003cstring>"}},"uniqueKey":"rivalProfile.rivals.items.[INDEX]","typeLabel":"object"},"description":"The competitors being watched.","minItems":1,"isRequired":true,"uniqueKey":"rivalProfile.rivals","typeLabel":"object[]"},"painVocabulary":{"type":"array","items":{"type":"string","description":"A complaint phrase.","uniqueKey":"rivalProfile.painVocabulary.items.[INDEX]","typeLabel":"string"},"description":"What people say when fed up with them.","isRequired":true,"uniqueKey":"rivalProfile.painVocabulary","typeLabel":"string[]"},"rationale":{"type":"string","description":"Why these rivals, shown above the editor.","uniqueKey":"rivalProfile.rationale","typeLabel":"string"}},"uniqueKey":"rivalProfile","typeLabel":"object"},"placesProfile":{"type":"object","description":"Local prospecting: the businesses whose own reviews are read for evidence of the problem this product solves.","required":["categories","locations","places","painVocabulary"],"properties":{"categories":{"type":"array","items":{"type":"string","description":"A category.","uniqueKey":"placesProfile.categories.items.[INDEX]","typeLabel":"string"},"description":"Business categories as Maps would name them: \"dental clinic\", \"law firm\".","isRequired":true,"uniqueKey":"placesProfile.categories","typeLabel":"string[]"},"locations":{"type":"array","items":{"type":"string","description":"A city or region.","uniqueKey":"placesProfile.locations.items.[INDEX]","typeLabel":"string"},"description":"Where to search.","isRequired":true,"uniqueKey":"placesProfile.locations","typeLabel":"string[]"},"places":{"type":"array","items":{"type":"object","description":"A specific business on Google Maps, confirmed by a person in the wizard.","required":["placeId","name"],"properties":{"placeId":{"type":"string","description":"Google's stable identifier.","isRequired":true,"uniqueKey":"placesProfile.places.items.[INDEX].placeId","typeLabel":"string"},"name":{"type":"string","description":"The business's name.","isRequired":true,"uniqueKey":"placesProfile.places.items.[INDEX].name","typeLabel":"string"},"cid":{"type":"string","description":"Maps cluster id, which the reviews endpoint prefers.","uniqueKey":"placesProfile.places.items.[INDEX].cid","typeLabel":"string"},"address":{"type":"string","description":"Its address, as Maps reports it.","uniqueKey":"placesProfile.places.items.[INDEX].address","typeLabel":"string"},"rating":{"type":"number","description":"Its overall rating.","minimum":0,"maximum":5,"uniqueKey":"placesProfile.places.items.[INDEX].rating","typeLabel":"number"},"reviewCount":{"type":"integer","description":"Its lifetime review count, which is not the number read.","minimum":0,"uniqueKey":"placesProfile.places.items.[INDEX].reviewCount","typeLabel":"integer"}},"uniqueKey":"placesProfile.places.items.[INDEX]","typeLabel":"object"},"description":"The confirmed prospect list. **Reviews are only ever read for these.**","isRequired":true,"uniqueKey":"placesProfile.places","typeLabel":"object[]"},"painVocabulary":{"type":"array","items":{"type":"string","description":"A complaint phrase.","uniqueKey":"placesProfile.painVocabulary.items.[INDEX]","typeLabel":"string"},"description":"The complaints that mean this business needs what you sell.","isRequired":true,"uniqueKey":"placesProfile.painVocabulary","typeLabel":"string[]"},"rationale":{"type":"string","description":"Why these categories, shown above the editor.","uniqueKey":"placesProfile.rationale","typeLabel":"string"}},"uniqueKey":"placesProfile","typeLabel":"object"},"autoPipeline":{"type":"object","description":"What this listener sends to the board by itself. Absent means never configured, which is the same as disabled: a listener that predates this must not start opening deals because a deploy happened.","required":["enabled","minScore","classifications","stage","dailyCap"],"properties":{"enabled":{"type":"boolean","description":"Whether it runs.","isRequired":true,"uniqueKey":"autoPipeline.enabled","typeLabel":"boolean"},"minScore":{"type":"integer","description":"The score bar. Higher than the alert rule's, because a deal stays on the board and counts against the win rate.","minimum":0,"maximum":100,"isRequired":true,"uniqueKey":"autoPipeline.minScore","typeLabel":"integer"},"classifications":{"type":"array","items":{"type":"string","enum":["high_intent","evaluating","relevant","competitor","content","strong_match","worth_a_look","stretch","mismatch","stale","hiring_now","expanding","replacing","adjacent","switching","frustrated","comparing","praise","pain_confirmed","at_risk","healthy","noise"],"description":"A classification.","uniqueKey":"autoPipeline.classifications.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Which classifications qualify.","minItems":1,"isRequired":true,"uniqueKey":"autoPipeline.classifications","typeLabel":"enum\u003cstring>[]"},"stage":{"type":"string","enum":["new","contacted","meeting","won","lost"],"description":"Where auto-added deals land.","isRequired":true,"uniqueKey":"autoPipeline.stage","typeLabel":"enum\u003cstring>"},"dailyCap":{"type":"integer","description":"Most deals to open in one day, across this listener.","minimum":1,"maximum":200,"isRequired":true,"uniqueKey":"autoPipeline.dailyCap","typeLabel":"integer"},"ownerUserId":{"type":"string","description":"Who the deal lands on. Unassigned is a legitimate answer: a shared triage board is a real way to work.","uniqueKey":"autoPipeline.ownerUserId","typeLabel":"string"}},"uniqueKey":"autoPipeline","typeLabel":"object"},"lastRunAt":{"type":"string","format":"date-time","description":"When it last ran. Absent until the first run.","uniqueKey":"lastRunAt","typeLabel":"string\u003cdate-time>"},"nextRunAt":{"type":"string","format":"date-time","description":"When it runs next, as of the last scheduler read.","uniqueKey":"nextRunAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","orgId":"\u003cstring>","createdBy":"\u003cstring>","companyName":"\u003cstring>","mode":"market","objective":"find_customers","sources":["x"],"schedule":"\u003cstring>","lookbackHours":2,"status":"draft","generatedKeywords":["\u003cstring>"],"createdAt":"2023-11-07T05:31:56Z","schedulerState":{"active":true,"pattern":"\u003cstring>","nextRunAt":"2023-11-07T05:31:56Z"},"customObjective":"\u003cstring>","website":"\u003cstring>","description":"\u003cstring>","minRelevanceScore":50,"sensitivity":"strict","maxRating":3,"blockedDomains":["\u003cstring>"],"communityHosts":["\u003cstring>"],"notifyEmails":["jsmith@example.com"],"retiredReason":"\u003cstring>","billingSuspendedAt":"2023-11-07T05:31:56Z","searchPlan":{"summary":"\u003cstring>","includeKeywords":["\u003cstring>"],"excludeKeywords":["\u003cstring>"],"queries":["\u003cstring>"],"plannedQueries":[{"text":"\u003cstring>","sources":["x"],"intent":"\u003cstring>"}],"disabledQueries":["\u003cstring>"]},"productProfile":{"offering":"\u003cstring>","audience":"\u003cstring>","capabilities":["\u003cstring>"],"differentiator":"\u003cstring>"},"rivalProfile":{"rivals":[{"name":"\u003cstring>","aliases":["\u003cstring>"],"places":[{"placeId":"\u003cstring>","name":"\u003cstring>","cid":"\u003cstring>","address":"\u003cstring>","rating":2.5,"reviewCount":1}],"website":"\u003cstring>","provenance":"user"}],"painVocabulary":["\u003cstring>"],"rationale":"\u003cstring>"},"placesProfile":{"categories":["\u003cstring>"],"locations":["\u003cstring>"],"places":[{"placeId":"\u003cstring>","name":"\u003cstring>","cid":"\u003cstring>","address":"\u003cstring>","rating":2.5,"reviewCount":1}],"painVocabulary":["\u003cstring>"],"rationale":"\u003cstring>"},"autoPipeline":{"enabled":true,"minScore":50,"classifications":["high_intent"],"stage":"new","dailyCap":100,"ownerUserId":"\u003cstring>"},"lastRunAt":"2023-11-07T05:31:56Z","nextRunAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"5dd64a34-6386-4e99-89e1-b7235c48957e":{"description":"The key is missing, malformed, expired or revoked.","content":{"application/json":{"schema":{"type":"object","description":"What went wrong, in a shape every failing route shares.","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable explanation, safe to show a user.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code, when the failure has one worth branching on. `website_unreadable` and `forbidden` are the two a caller acts on.","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Validator output on a 400, as an array of issues naming the offending field. Diagnostic only: the shape comes from the validation library and is not part of the contract.","uniqueKey":"detail","typeLabel":"any"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","detail":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e3746660-ffad-4544-aa58-a353b999b778":{"description":"The key lacks the `listeners:read` scope.","content":{"application/json":{"schema":{"type":"object","description":"What went wrong, in a shape every failing route shares.","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable explanation, safe to show a user.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code, when the failure has one worth branching on. `website_unreadable` and `forbidden` are the two a caller acts on.","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Validator output on a 400, as an array of issues naming the offending field. Diagnostic only: the shape comes from the validation library and is not part of the contract.","uniqueKey":"detail","typeLabel":"any"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","detail":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"de982680-5ae1-4ee3-94ce-d24cebbeb6fa":{"description":"No listener with this id, or it belongs to another workspace.","content":{"application/json":{"schema":{"type":"object","description":"What went wrong, in a shape every failing route shares.","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable explanation, safe to show a user.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code, when the failure has one worth branching on. `website_unreadable` and `forbidden` are the two a caller acts on.","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Validator output on a 400, as an array of issues naming the offending field. Diagnostic only: the shape comes from the validation library and is not part of the contract.","uniqueKey":"detail","typeLabel":"any"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","detail":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5a920ae2-2831-49cf-80e7-566bffd4d0f3":{"description":"Too many requests from this key. `Retry-After` carries the seconds to wait.","content":{"application/json":{"schema":{"type":"object","description":"What went wrong, in a shape every failing route shares.","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable explanation, safe to show a user.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code, when the failure has one worth branching on. `website_unreadable` and `forbidden` are the two a caller acts on.","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Validator output on a 400, as an array of issues naming the offending field. Diagnostic only: the shape comes from the validation library and is not part of the contract.","uniqueKey":"detail","typeLabel":"any"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","detail":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f989bd12-5923-4e83-b18c-ab3fda03f8a6":{"apiKey":{"type":"http","scheme":"bearer","description":"A workspace API key, created in workspace settings and sent as `Authorization: Bearer op_live_…`. Session cookies are not accepted. Scopes: signals:read, accounts:read, listeners:read, listeners:analyse, pipeline:read, pipeline:write, collections:write, export:read.","scopes":["listeners:read"],"schemeName":"apiKey"}}},"servers":{"15b4899c-a482-4812-8f0c-fad24a079ee3":{"url":"https://api.openpulse.cloud","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A workspace API key, created in workspace settings and sent as `Authorization: Bearer op_live_…`. Session cookies are not accepted. Scopes: signals:read, accounts:read, listeners:read, listeners:analyse, pipeline:read, pipeline:write, collections:write, export:read.","scopes":["listeners:read"],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A workspace API key, created in workspace settings and sent as `Authorization: Bearer op_live_…`. Session cookies are not accepted. Scopes: signals:read, accounts:read, listeners:read, listeners:analyse, pipeline:read, pipeline:write, collections:write, export:read.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"open-pulse","siteName":"Open Pulse","title":"Get one listener - Open Pulse","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T06:52:28.419Z","originalFileLocation":"api-reference/listeners/get-one-listener.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=\"One listener with its full configuration — keywords, exclusions, per-source queries, sensitivity and schedule — plus its current scheduler state. An id belonging to another workspace is indistinguishable from one that does not exist: both answer 404.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Open Pulse\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/open-pulse/_XSUl-ciJBzq3c0r/_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/open-pulse/_XSUl-ciJBzq3c0r/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/open-pulse/_XSUl-ciJBzq3c0r/_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/open-pulse/_XSUl-ciJBzq3c0r/_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/open-pulse/_XSUl-ciJBzq3c0r/_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/open-pulse/_XSUl-ciJBzq3c0r/_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/open-pulse/_XSUl-ciJBzq3c0r/_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/open-pulse/_XSUl-ciJBzq3c0r/_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/open-pulse/_XSUl-ciJBzq3c0r/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get one listener - Open Pulse\">\u003cmeta data-mint-head property=\"og:description\" content=\"One listener with its full configuration — keywords, exclusions, per-source queries, sensitivity and schedule — plus its current scheduler state. An id belonging to another workspace is indistinguishable from one that does not exist: both answer 404.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Open Pulse\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.openpulse.cloud/api-reference/listeners/get-one-listener\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://open-pulse.mintlify.site/_mintlify/api/og/v2?division=Listeners\u0026amp;title=Get+one+listener\u0026amp;description=One+listener+with+its+full+configuration+%E2%80%94+keywords%2C+exclusions%2C+per-source+queries%2C+sensitivity+and+schedule+%E2%80%94+plus+its+current+scheduler+state.%0A%0AAn+id+belongi\u0026amp;theme=d63bc05a3d20cd1eea42e14a\u0026amp;signature=0fa43c642a07bca1304b17392dc9e2395679790f65d071e4893f2bcc7db71493\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get one listener - Open Pulse\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"One listener with its full configuration — keywords, exclusions, per-source queries, sensitivity and schedule — plus its current scheduler state. An id belonging to another workspace is indistinguishable from one that does not exist: both answer 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://open-pulse.mintlify.site/_mintlify/api/og/v2?division=Listeners\u0026amp;title=Get+one+listener\u0026amp;description=One+listener+with+its+full+configuration+%E2%80%94+keywords%2C+exclusions%2C+per-source+queries%2C+sensitivity+and+schedule+%E2%80%94+plus+its+current+scheduler+state.%0A%0AAn+id+belongi\u0026amp;theme=d63bc05a3d20cd1eea42e14a\u0026amp;signature=0fa43c642a07bca1304b17392dc9e2395679790f65d071e4893f2bcc7db71493\">\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/open-pulse/_XSUl-ciJBzq3c0r/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Open Pulse\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#446317\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.openpulse.cloud/api-reference/listeners/get-one-listener\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/listeners/get-one-listener.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.openpulse.cloud/#organization\",\"name\":\"Open Pulse\",\"url\":\"https://docs.openpulse.cloud\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/open-pulse/2lhu05m2dSiIFlof/logo/light.svg?fit=max\u0026auto=format\u0026n=2lhu05m2dSiIFlof\u0026q=85\u0026s=a403a5531b58270dadb02f1862164683\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.openpulse.cloud#website\",\"name\":\"Open Pulse\",\"url\":\"https://docs.openpulse.cloud\",\"publisher\":{\"@id\":\"https://docs.openpulse.cloud/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.openpulse.cloud/api-reference/listeners/get-one-listener#webpage\",\"url\":\"https://docs.openpulse.cloud/api-reference/listeners/get-one-listener\",\"name\":\"Get one listener\",\"description\":\"One listener with its full configuration — keywords, exclusions, per-source queries, sensitivity and schedule — plus its current scheduler state. An id belonging to another workspace is indistinguishable from one that does not exist: both answer 404.\",\"dateModified\":\"2026-10-27T06:52:28.419Z\",\"isPartOf\":{\"@id\":\"https://docs.openpulse.cloud#website\"},\"breadcrumb\":{\"@id\":\"https://docs.openpulse.cloud/api-reference/listeners/get-one-listener#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.openpulse.cloud/api-reference/listeners/get-one-listener#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Listeners\",\"item\":\"https://docs.openpulse.cloud/api-reference/listeners/list-listeners\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get one listener\",\"item\":\"https://docs.openpulse.cloud/api-reference/listeners/get-one-listener\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.openpulse.cloud/api-reference/listeners/get-one-listener#apireference\",\"headline\":\"Get one listener\",\"name\":\"Get one listener\",\"description\":\"One listener with its full configuration — keywords, exclusions, per-source queries, sensitivity and schedule — plus its current scheduler state. An id belonging to another workspace is indistinguishable from one that does not exist: both answer 404.\",\"url\":\"https://docs.openpulse.cloud/api-reference/listeners/get-one-listener\",\"mainEntityOfPage\":{\"@id\":\"https://docs.openpulse.cloud/api-reference/listeners/get-one-listener#webpage\"},\"dateModified\":\"2026-10-27T06:52:28.419Z\",\"publisher\":{\"@id\":\"https://docs.openpulse.cloud/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.openpulse.cloud#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Open Pulse\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Open Pulse","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Listeners","pages":[{"title":"List listeners","description":"Every listener in the workspace, newest first, cursor-paginated. Each item carries its mode, its objective, its schedule and a count of the signals it has kept.\n\nA key can read listeners and never change one: creating, editing and deleting a listener spends money on a recurring basis and stays with workspace admins.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/listeners","href":"/api-reference/listeners/list-listeners"},{"title":"Get one listener","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/listeners/{id}","href":"/api-reference/listeners/get-one-listener"},{"title":"Derive a listener plan from a website","description":"Crawls a website and returns a complete listener plan: keywords, exclusions, per-source queries, and a mode-specific profile — target roles, rival names and pain vocabulary, or place categories. Everything is editable before it runs.\n\nThis is the step every competing product replaces with an empty keyword box.\n\nRate limited to 5 calls an hour per key, and counted against the workspace's monthly allowance. An unreadable website answers 422 with `website_unreadable` rather than an error: the caller is asked to describe the business instead. Nothing is counted against the allowance unless the analysis succeeded.\n\nTo recover from a `website_unreadable` 422, resend the same request with `description` filled in and `acceptLimited: true`: the plan is then generated from the description instead of a crawl.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/listeners/analyse-website","href":"/api-reference/listeners/derive-a-listener-plan-from-a-website"}]},{"group":"Results","pages":[{"title":"List signals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/results","href":"/api-reference/results/list-signals"},{"title":"Get one signal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/results/{id}","href":"/api-reference/results/get-one-signal"},{"title":"Count signals in a window","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/results/stats","href":"/api-reference/results/count-signals-in-a-window"},{"title":"Save a signal to a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/signals/{id}/save","href":"/api-reference/signals/save-a-signal-to-a-list"}]},{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Get one account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/accounts/{key}","href":"/api-reference/accounts/get-one-account"}]},{"group":"Pipeline","pages":[{"title":"List deals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pipeline","href":"/api-reference/pipeline/list-deals"},{"title":"Add a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pipeline","href":"/api-reference/pipeline/add-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/pipeline/{id}","href":"/api-reference/pipeline/update-a-deal"},{"title":"Add several deals at once","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pipeline/bulk","href":"/api-reference/pipeline/add-several-deals-at-once"},{"title":"Pipeline return over a window","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pipeline/roi","href":"/api-reference/pipeline/pipeline-return-over-a-window"}]},{"group":"Collections \u0026 Notes","pages":[{"title":"Create a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/collections","href":"/api-reference/collections/create-a-list"},{"title":"Write a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/notes","href":"/api-reference/notes/write-a-note"}]},{"group":"Content","pages":[{"title":"Download a push's content as a zip","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/content/pushes/{id}/export.zip","href":"/api-reference/content/download-a-pushs-content-as-a-zip"}]},{"group":"Exports","pages":[{"title":"Export accounts as CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/exports/accounts.csv","href":"/api-reference/exports/export-accounts-as-csv"},{"title":"Export the pipeline as CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/exports/pipeline.csv","href":"/api-reference/exports/export-the-pipeline-as-csv"},{"title":"Export signals as CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/exports/signals.csv","href":"/api-reference/exports/export-signals-as-csv"}]}]}]},"basePath":"","title":"Get one listener - Open Pulse","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"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","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.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"]}