Returns everything the store declares — its typed fields, its record key, the complete set of sources that may write to it — plus the precedence in effect for your account, how many records are still awaiting recompute, how far the store is behind the current reference-data generation, how much of its carrier data came from a per-number lookup rather than an area-code estimate, and how many of its numbers cannot receive a callback. An unknown store returns 404.
GET
/
data
/
stores
/
{store}
Get a data store
curl --request GET \ --url https://api.getdialed.ai/v1/data/stores/{store} \ --header 'X-API-Key: <api-key>'
Everything one store declares, plus the precedence in effect for you.
The field map is the store's own type declaration, so a form or table can be
rendered from this response alone — including which values are allowed, which
may be null, and how each value should be handled.
The precedence currently deciding this store's resolved values.
For each field, the first source in that field's order which asserts a
value wins. A field's order is also the list of sources allowed to write it,
so one place answers both "who wins" and "who may say anything at all".
Version of your precedence settings. Every record records the version its resolved view was computed with, which is what makes a view left behind by a precedence change detectable.
Whether every record's resolved view reflects the current precedence.
Changing precedence invalidates the resolved views computed under the old
settings, and they are recomputed in the background. While that is running,
bulk queries legitimately mix records resolved under the old precedence with
records resolved under the new one. pending reaching zero is how you know
the window has closed.
How far this store's records are behind the current reference data.
Exchange reference data is published in generations. Every record is
stamped with the generation its geographic facts came from, and a
background sweep brings records that are behind up to the current one.
This block answers "how many are behind, and against which generation was
that counted".
The generations named here ARE the ones the count was taken against.
They are read once and the count filters on exactly them, because a count
taken against one generation and reported beside another is a number
nobody could act on.
How much of this store's carrier and line-type data was looked up.
Two facts about a number's carrier are kept apart on purpose. Carrier
and Line type come from a per-number lookup and describe that exact
number. Area code carrier and Area code line type come from the
number's NPA-NXX block and describe the block, not the number — a ported
number's block says nothing about who carries it today. These counts say
how many of this store's numbers have each.
looked_up and estimated_only never overlap: a number with a per-number
answer is counted in the first and nowhere else, whatever its area-code
estimate says.
How many of this store's numbers are in no inbound campaign. A number in none cannot receive a callback: somebody who returns the call reaches nothing. Zero is the healthy answer.
How long history rows are kept. Null means indefinitely.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"GetDialed Docs","colors":{"primary":"#4F46E5","light":"#818CF8","dark":"#3730A3"},"logo":{"light":"https://mintcdn.com/getdialed/aL0yqdSUKnvM2urY/logo/light.svg?fit=max\u0026auto=format\u0026n=aL0yqdSUKnvM2urY\u0026q=85\u0026s=f6bd462ed94234572b2ef5546432f2e6","dark":"https://mintcdn.com/getdialed/aL0yqdSUKnvM2urY/logo/dark.svg?fit=max\u0026auto=format\u0026n=aL0yqdSUKnvM2urY\u0026q=85\u0026s=d1c6a3c7e0c6c51c197026d4f6e5828b","href":"https://getdialed.ai"},"favicon":"https://mintcdn.com/getdialed/hCWbIPF0pnvtMb9m/favicon.ico?fit=max\u0026auto=format\u0026n=hCWbIPF0pnvtMb9m\u0026q=85\u0026s=f2bdd6a91d61e358c1f0958dfa3a7ba6","footer":{"socials":{"website":"https://getdialed.ai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"getdialed","hasAudioNarration":false,"actualSubdomain":"getdialed","customDomains":["docs.getdialed.ai"],"gitSource":{"type":"gitlab","owner":"getdialed","repo":"gdf","deployBranch":"master","contentDirectory":"docs-site","isPrivate":true,"projectId":79547483,"mountPath":"","label":""},"chroma":{"collectionId":"e7cf6d55-9268-46be-aa47-d76035f822d6","liveDeploymentHistoryId":"6accf41d5f90b4d42c2fc095","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6accf41d5f90b4d42c2fc095"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ada2fd916a91434b90658d1","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":114},{"language":"default","tag":"Flows — /v1/flows","count":56},{"language":"default","tag":"Documentation","count":42},{"language":"default","tag":"Core Concepts","count":28},{"language":"default","tag":"Data — /v1/data","count":13},{"language":"default","tag":"Five9 Domains — /v1/platforms/five9","count":13},{"language":"default","tag":"Batches","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Variables","count":8},{"language":"default","tag":"Admin — /v1/admin","count":7}]},"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":"vite-origin","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar a[href=\"https://getdialed.ai\"] img,#navbar .nav-logo img,#navbar .nav-logo{height:2.75rem!important;max-height:2.75rem!important}#navbar a[href=\"https://getdialed.ai\"]{display:flex;align-items:center;gap:0.6rem}#navbar a[href=\"https://getdialed.ai\"]::after{content:\"Docs\";font-size:0.875rem;font-weight:500;color:#64748b;line-height:1}html.dark #navbar a[href=\"https://getdialed.ai\"]::after{color:#94a3b8}"}],"page":{"pagePath":"api-reference/data-stores/get-a-data-store","slug":"/api-reference/data-stores/get-a-data-store","pageMetadata":{"title":"Get a data store","description":"Returns everything the store declares — its typed fields, its record key, the complete set of sources that may write to it — plus the precedence in effect for your account, how many records are still awaiting recompute, how far the store is behind the current reference-data generation, how much of its carrier data came from a per-number lookup rather than an area-code estimate, and how many of its numbers cannot receive a callback. An unknown store returns 404.","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}","href":"/api-reference/data-stores/get-a-data-store","autogeneratedByOpenApi":true},"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: \"Returns everything the store declares — its typed fields, its record key, the complete set of sources that may write to it — plus the precedence in effect for your account, how many records are still awaiting recompute, how far the store is behind the current reference-data generation, how much of its carrier data came from a per-number lookup rather than an area-code estimate, and how many of its numbers cannot receive a callback. An unknown store returns 404.\"\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 a data store","description":"Returns everything the store declares — its typed fields, its record key, the complete set of sources that may write to it — plus the precedence in effect for your account, how many records are still awaiting recompute, how far the store is behind the current reference-data generation, how much of its carrier data came from a per-number lookup rather than an area-code estimate, and how many of its numbers cannot receive a callback. An unknown store returns 404.","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}","href":"/api-reference/data-stores/get-a-data-store","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["data-stores"],"summary":"Get a data store","description":"Returns everything the store declares — its typed fields, its record key, the complete set of sources that may write to it — plus the precedence in effect for your account, how many records are still awaiting recompute, how far the store is behind the current reference-data generation, how much of its carrier data came from a per-number lookup rather than an area-code estimate, and how many of its numbers cannot receive a callback. An unknown store returns 404.","operationId":"get_store_data_stores__store__get","security":["c12d429d-dc9b-4f3b-975b-9a351a4184f5","eadaa4f9-0733-44c4-b6bf-ffbfc5e88596"],"parameters":["f6d2247c-a1f6-41f1-8d76-e5cf7a5f22e8"],"responses":{"200":"33f7eaee-3a98-41f5-b9c3-925a4894bd28","401":"3457120f-2131-404e-81c2-315acf12f6c3","404":"0e0ca248-bf9c-4998-8a12-4a9dfebcdef1","422":"be2fe7ad-304b-497a-94aa-084a3f8595ff","429":"7a1d9d81-16ae-4116-9b79-42a8bd8d212d"},"method":"get","type":"path","servers":["46b27330-8729-49f8-bc01-5b7026690c37"],"path":"/data/stores/{store}","baseUrlOptions":["https://api.getdialed.ai/v1"],"title":"Get a data store","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f6d2247c-a1f6-41f1-8d76-e5cf7a5f22e8":{"name":"store","in":"path","required":true,"schema":{"type":"string","title":"Store","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"33f7eaee-3a98-41f5-b9c3-925a4894bd28":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"slug":{"type":"string","title":"Slug","description":"Identifies the store in every store URL.","isRequired":true,"uniqueKey":"slug","typeLabel":"string"},"tier":{"type":"string","title":"Tier","description":"Which kind of store this is.","isRequired":true,"uniqueKey":"tier","typeLabel":"string"},"version":{"type":"integer","title":"Version","description":"Version of the store's platform declaration.","isRequired":true,"uniqueKey":"version","typeLabel":"integer"},"record_key":{"properties":{"field":{"type":"string","title":"Field","description":"Which field of the record is its key.","isRequired":true,"uniqueKey":"record_key.field","typeLabel":"string"},"format":{"type":"string","title":"Format","description":"The canonical form the key is stored in. `e164` means every key is a phone number in E.164 form, and a value that cannot be normalized to it is refused rather than stored as written.","isRequired":true,"uniqueKey":"record_key.format","typeLabel":"string"}},"type":"object","required":["field","format"],"title":"StoreRecordKeyResponse","description":"How a store's record key is formed.","isRequired":true,"uniqueKey":"record_key","typeLabel":"StoreRecordKeyResponse · object"},"fields":{"additionalProperties":{"properties":{"type":{"type":"string","enum":["string","number","boolean","object","array","datetime","connection_ref"],"title":"Type","isRequired":true,"uniqueKey":"fields.additionalProperties.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","title":"Description","isRequired":true,"uniqueKey":"fields.additionalProperties.description","typeLabel":"string"},"sensitivity":{"type":"string","enum":["none","pii","phi","secret"],"title":"Sensitivity","isRequired":true,"uniqueKey":"fields.additionalProperties.sensitivity","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","title":"Required","default":false,"uniqueKey":"fields.additionalProperties.required","typeLabel":"boolean"},"default":{"oneOf":[{"title":"Default"},{"type":"null","title":"Default","uniqueKey":"fields.additionalProperties.default.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.additionalProperties.default","typeLabel":"null"},"enum":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"fields.additionalProperties.enum.oneOf.0.items.[INDEX]","typeLabel":"any"},"title":"Enum","uniqueKey":"fields.additionalProperties.enum.oneOf.0","typeLabel":"any[]"},{"type":"null","title":"Enum","uniqueKey":"fields.additionalProperties.enum.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.additionalProperties.enum","typeLabel":"any[] | null"},"example":{"oneOf":[{"title":"Example"},{"type":"null","title":"Example","uniqueKey":"fields.additionalProperties.example.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.additionalProperties.example","typeLabel":"null"},"nullable":{"type":"boolean","title":"Nullable","default":false,"uniqueKey":"fields.additionalProperties.nullable","typeLabel":"boolean"},"items":{"oneOf":[{},{"type":"null","uniqueKey":"fields.additionalProperties.\\items.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.additionalProperties.\\items","typeLabel":"null"},"properties":{"oneOf":[{"type":"object","title":"Properties","uniqueKey":"fields.additionalProperties.properties.oneOf.0","typeLabel":"Properties · object"},{"type":"null","title":"Properties","uniqueKey":"fields.additionalProperties.properties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.additionalProperties.properties","typeLabel":"Properties · object | null"},"group":{"oneOf":[{"type":"string","title":"Group","uniqueKey":"fields.additionalProperties.group.oneOf.0","typeLabel":"string"},{"type":"null","title":"Group","uniqueKey":"fields.additionalProperties.group.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.additionalProperties.group","typeLabel":"string | null"},"order":{"oneOf":[{"type":"integer","title":"Order","uniqueKey":"fields.additionalProperties.order.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Order","uniqueKey":"fields.additionalProperties.order.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.additionalProperties.order","typeLabel":"integer | null"},"secret":{"type":"boolean","title":"Secret","default":false,"uniqueKey":"fields.additionalProperties.secret","typeLabel":"boolean"},"hidden":{"type":"boolean","title":"Hidden","default":false,"uniqueKey":"fields.additionalProperties.hidden","typeLabel":"boolean"}},"type":"object","required":["type","description","sensitivity"],"title":"FieldSchema","description":"Describes a single typed field completely enough to render a form for it.\n\nEvery field declares a ``type``, a human-readable ``description``, and a\n``sensitivity`` classification (``none``, ``pii``, ``phi`` or ``secret``), so\nthe handling a value requires is always explicit rather than inferred. A\nfield classified ``secret`` is always rendered masked.\n\n``required``, ``default``, ``enum``, ``example``, ``nullable``, ``group`` and\n``order`` are the presentation and validation hints a generic form needs.\n``items`` describes the element type of an ``array`` and ``properties``\ndescribes the members of an ``object``. ``hidden`` marks a field that is\nsupplied automatically and should never be presented for entry.\n\nA field of type ``connection_ref`` means \"supply a credential here\". Which\ncredentials are acceptable is determined by the service the action belongs\nto: for a vendor service, a credential belonging to a tenant of that\nservice's platform whose authentication mechanism matches the one the\nservice declares; for a first-party service, a credential whose\nauthentication kind the service accepts. The field names no service itself,\nso the set of acceptable credentials can never go stale against the service\nit is read from.","uniqueKey":"fields.additionalProperties","typeLabel":"FieldSchema · object"},"type":"object","title":"Fields","description":"Every field the store declares, keyed by field name.","isRequired":true,"uniqueKey":"fields","typeLabel":"Fields · object"},"sources":{"items":{"type":"string","uniqueKey":"sources.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Sources","description":"Every source that may ever write a layer to this store.","isRequired":true,"uniqueKey":"sources","typeLabel":"string[]"},"precedence":{"properties":{"default_order":{"items":{"type":"string","uniqueKey":"precedence.default_order.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Default Order","description":"The order every field resolves by unless it is overridden.","isRequired":true,"uniqueKey":"precedence.default_order","typeLabel":"string[]"},"field_overrides":{"additionalProperties":{"items":{"type":"string","uniqueKey":"precedence.field_overrides.additionalProperties.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"precedence.field_overrides.additionalProperties","typeLabel":"string[]"},"type":"object","title":"Field Overrides","description":"Per-field orders that depart from the default. A field absent here uses `default_order`.","uniqueKey":"precedence.field_overrides","typeLabel":"Field Overrides · object"}},"type":"object","required":["default_order"],"title":"StorePrecedenceResponse","description":"The precedence currently deciding this store's resolved values.\n\nFor each field, the first source in that field's order which asserts a\nvalue wins. A field's order is also the list of sources allowed to write it,\nso one place answers both \"who wins\" and \"who may say anything at all\".","isRequired":true,"uniqueKey":"precedence","typeLabel":"StorePrecedenceResponse · object"},"config_version":{"type":"integer","title":"Config Version","description":"Version of your precedence settings. Every record records the version its resolved view was computed with, which is what makes a view left behind by a precedence change detectable.","isRequired":true,"uniqueKey":"config_version","typeLabel":"integer"},"recompute":{"properties":{"pending":{"type":"integer","title":"Pending","description":"How many records still carry a resolved view computed with an older precedence version. Zero means every record is current.","isRequired":true,"uniqueKey":"recompute.pending","typeLabel":"integer"}},"type":"object","required":["pending"],"title":"StoreRecomputeResponse","description":"Whether every record's resolved view reflects the current precedence.\n\nChanging precedence invalidates the resolved views computed under the old\nsettings, and they are recomputed in the background. While that is running,\nbulk queries legitimately mix records resolved under the old precedence with\nrecords resolved under the new one. `pending` reaching zero is how you know\nthe window has closed.","isRequired":true,"uniqueKey":"recompute","typeLabel":"StoreRecomputeResponse · object"},"exchange_lag":{"properties":{"count":{"type":"integer","title":"Count","description":"How many records are not stamped with a current generation. Zero means every record is up to date.","isRequired":true,"uniqueKey":"exchange_lag.count","typeLabel":"integer"},"live_snapshot_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"exchange_lag.live_snapshot_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Live Snapshot Ids","description":"The generations the count was taken against. **Null means no sweep has completed yet** — in that case `count` is how many records carry no generation stamp at all, which is a different answer from 'nothing is behind' and must not be read as one.","uniqueKey":"exchange_lag.live_snapshot_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Live Snapshot Ids","description":"The generations the count was taken against. **Null means no sweep has completed yet** — in that case `count` is how many records carry no generation stamp at all, which is a different answer from 'nothing is behind' and must not be read as one.","uniqueKey":"exchange_lag.live_snapshot_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"exchange_lag.live_snapshot_ids","typeLabel":"string[] | null"},"last_sweep_at":{"oneOf":[{"type":"string","title":"Last Sweep At","description":"When the last sweep that visited every record finished. Null when none has. A sweep that stopped at its page budget is not reported here: it did not visit the whole store, so its finishing time would overstate the coverage behind `count`.","format":"date-time","uniqueKey":"exchange_lag.last_sweep_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Sweep At","description":"When the last sweep that visited every record finished. Null when none has. A sweep that stopped at its page budget is not reported here: it did not visit the whole store, so its finishing time would overstate the coverage behind `count`.","uniqueKey":"exchange_lag.last_sweep_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"exchange_lag.last_sweep_at","typeLabel":"string\u003cdate-time> | null"}},"type":"object","required":["count"],"title":"ExchangeLagResponse","description":"How far this store's records are behind the current reference data.\n\nExchange reference data is published in generations. Every record is\nstamped with the generation its geographic facts came from, and a\nbackground sweep brings records that are behind up to the current one.\nThis block answers \"how many are behind, and against which generation was\nthat counted\".\n\n**The generations named here ARE the ones the count was taken against.**\nThey are read once and the count filters on exactly them, because a count\ntaken against one generation and reported beside another is a number\nnobody could act on.","isRequired":true,"uniqueKey":"exchange_lag","typeLabel":"ExchangeLagResponse · object"},"lookup_counts":{"properties":{"looked_up":{"type":"integer","title":"Looked Up","description":"How many numbers have a Carrier and Line type from a per-number lookup. These describe the number itself.","isRequired":true,"uniqueKey":"lookup_counts.looked_up","typeLabel":"integer"},"estimated_only":{"type":"integer","title":"Estimated Only","description":"How many numbers carry only an Area code carrier — the estimate taken from the number's NPA-NXX block, which describes the block rather than the number. No per-number lookup has answered for these.","isRequired":true,"uniqueKey":"lookup_counts.estimated_only","typeLabel":"integer"},"owed":{"type":"integer","title":"Owed","description":"How many numbers are queued for a lookup that has not run yet. Zero is the healthy answer. A number waits here rather than failing its import, so a queue is a delay, never lost data.","isRequired":true,"uniqueKey":"lookup_counts.owed","typeLabel":"integer"},"failed":{"type":"integer","title":"Failed","description":"How many numbers had a lookup attempted that did not produce an answer. They are retried on the next sweep; they are not abandoned.","isRequired":true,"uniqueKey":"lookup_counts.failed","typeLabel":"integer"},"last_sweep_at":{"oneOf":[{"type":"string","title":"Last Sweep At","description":"When the last sweep that visited every record finished. **Null means no sweep has completed yet** — read the counts beside it as a first reading rather than a steady state. Null is not a zero and must not be rendered as one.","format":"date-time","uniqueKey":"lookup_counts.last_sweep_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Sweep At","description":"When the last sweep that visited every record finished. **Null means no sweep has completed yet** — read the counts beside it as a first reading rather than a steady state. Null is not a zero and must not be rendered as one.","uniqueKey":"lookup_counts.last_sweep_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"lookup_counts.last_sweep_at","typeLabel":"string\u003cdate-time> | null"}},"type":"object","required":["looked_up","estimated_only","owed","failed"],"title":"LookupCountsResponse","description":"How much of this store's carrier and line-type data was looked up.\n\nTwo facts about a number's carrier are kept apart on purpose. **Carrier**\nand **Line type** come from a per-number lookup and describe that exact\nnumber. **Area code carrier** and **Area code line type** come from the\nnumber's NPA-NXX block and describe the block, not the number — a ported\nnumber's block says nothing about who carries it today. These counts say\nhow many of this store's numbers have each.\n\n`looked_up` and `estimated_only` never overlap: a number with a per-number\nanswer is counted in the first and nowhere else, whatever its area-code\nestimate says.","isRequired":true,"uniqueKey":"lookup_counts","typeLabel":"LookupCountsResponse · object"},"callback_incapable_count":{"type":"integer","title":"Callback Incapable Count","description":"How many of this store's numbers are in no inbound campaign. A number in none cannot receive a callback: somebody who returns the call reaches nothing. Zero is the healthy answer.","isRequired":true,"uniqueKey":"callback_incapable_count","typeLabel":"integer"},"changed_event_type":{"type":"string","title":"Changed Event Type","description":"The event emitted when a record's resolved value changes. Subscribe to this exact name to react to changes.","isRequired":true,"uniqueKey":"changed_event_type","typeLabel":"string"},"summary_event_type":{"type":"string","title":"Summary Event Type","description":"The event emitted once per completed sync, carrying that sync's totals. Subscribe to this one for bulk reactions.","isRequired":true,"uniqueKey":"summary_event_type","typeLabel":"string"},"record_retention_days":{"oneOf":[{"type":"integer","title":"Record Retention Days","description":"How long records are kept. Null means indefinitely.","uniqueKey":"record_retention_days.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Record Retention Days","description":"How long records are kept. Null means indefinitely.","uniqueKey":"record_retention_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"record_retention_days","typeLabel":"integer | null"},"history_retention_days":{"oneOf":[{"type":"integer","title":"History Retention Days","description":"How long history rows are kept. Null means indefinitely.","uniqueKey":"history_retention_days.oneOf.0","typeLabel":"integer"},{"type":"null","title":"History Retention Days","description":"How long history rows are kept. Null means indefinitely.","uniqueKey":"history_retention_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"history_retention_days","typeLabel":"integer | null"}},"type":"object","required":["slug","tier","version","record_key","fields","sources","precedence","config_version","recompute","exchange_lag","lookup_counts","callback_incapable_count","changed_event_type","summary_event_type"],"title":"StoreDetailResponse","description":"Everything one store declares, plus the precedence in effect for you.\n\nThe field map is the store's own type declaration, so a form or table can be\nrendered from this response alone — including which values are allowed, which\nmay be null, and how each value should be handled.","uniqueKey":"","typeLabel":"StoreDetailResponse · object"},"examples":{"Example":{"title":"Example","value":{"slug":"\u003cstring>","tier":"\u003cstring>","version":123,"record_key":{"field":"\u003cstring>","format":"\u003cstring>"},"fields":{},"sources":["\u003cstring>"],"precedence":{"default_order":["\u003cstring>"],"field_overrides":{}},"config_version":123,"recompute":{"pending":123},"exchange_lag":{"count":123,"live_snapshot_ids":["\u003cstring>"],"last_sweep_at":"2023-11-07T05:31:56Z"},"lookup_counts":{"looked_up":123,"estimated_only":123,"owed":123,"failed":123,"last_sweep_at":"2023-11-07T05:31:56Z"},"callback_incapable_count":123,"changed_event_type":"\u003cstring>","summary_event_type":"\u003cstring>","record_retention_days":123,"history_retention_days":123}}},"exampleType":"generated"}},"exampleType":"generated"},"3457120f-2131-404e-81c2-315acf12f6c3":{"description":"Missing or invalid authentication","content":{"application/json":{"example":{"detail":"Authentication required"},"examples":{"Example":{"title":"Example","value":{"detail":"Authentication required"}}},"exampleType":"examples"}},"exampleType":"examples"},"0e0ca248-bf9c-4998-8a12-4a9dfebcdef1":{"description":"Not found — also returned on cross-tenant access (never 403)","content":{"application/json":{"example":{"detail":"Store not found"},"examples":{"Example":{"title":"Example","value":{"detail":"Store not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"be2fe7ad-304b-497a-94aa-084a3f8595ff":{"description":"Validation error (see body for field details)","content":{"application/json":{"example":{"detail":"Validation error"},"examples":{"Example":{"title":"Example","value":{"detail":"Validation error"}}},"exampleType":"examples"}},"exampleType":"examples"},"7a1d9d81-16ae-4116-9b79-42a8bd8d212d":{"description":"Rate limit exceeded — retry after the Retry-After header","content":{"application/json":{"example":{"detail":"Rate limit exceeded"},"examples":{"Example":{"title":"Example","value":{"detail":"Rate limit exceeded"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"c12d429d-dc9b-4f3b-975b-9a351a4184f5":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"APIKeyHeader"}},"eadaa4f9-0733-44c4-b6bf-ffbfc5e88596":{"HTTPBearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"HTTPBearer"}}},"servers":{"46b27330-8729-49f8-bc01-5b7026690c37":{"url":"https://api.getdialed.ai/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"APIKeyHeader"},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"X-API-Key"}],"title":"APIKeyHeader"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"getdialed","siteName":"GetDialed Docs","title":"Get a data store - GetDialed Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T15:46:43.715Z","originalFileLocation":"api-reference/data-stores/get-a-data-store.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns everything the store declares — its typed fields, its record key, the complete set of sources that may write to it — plus the precedence in effect for your account, how many records are still awaiting recompute, how far the store is behind the current reference-data generation, how much of its carrier data came from a per-number lookup rather than an area-code estimate, and how many of its numbers cannot receive a callback. An unknown store returns 404.\">\u003cmeta data-mint-head name=\"application-name\" content=\"GetDialed Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a data store - GetDialed Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns everything the store declares — its typed fields, its record key, the complete set of sources that may write to it — plus the precedence in effect for your account, how many records are still awaiting recompute, how far the store is behind the current reference-data generation, how much of its carrier data came from a per-number lookup rather than an area-code estimate, and how many of its numbers cannot receive a callback. An unknown store returns 404.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"GetDialed Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getdialed.ai/api-reference/data-stores/get-a-data-store\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://getdialed.mintlify.app/_mintlify/api/og/v2?division=Data+%E2%80%94+%2Fv1%2Fdata\u0026amp;title=Get+a+data+store\u0026amp;description=Returns+everything+the+store+declares+%E2%80%94+its+typed+fields%2C+its+record+key%2C+the+complete+set+of+sources+that+may+write+to+it+%E2%80%94+plus+the+precedence+in+effect+for+y\u0026amp;theme=b6a8f417cb6da704c51ca7d7\u0026amp;signature=85e0f52a9225fc446843a603c5de683603df58b64d2de9cd76d2f5cd7bf2c4ff\">\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 a data store - GetDialed Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns everything the store declares — its typed fields, its record key, the complete set of sources that may write to it — plus the precedence in effect for your account, how many records are still awaiting recompute, how far the store is behind the current reference-data generation, how much of its carrier data came from a per-number lookup rather than an area-code estimate, and how many of its numbers cannot receive a callback. An unknown store returns 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://getdialed.mintlify.app/_mintlify/api/og/v2?division=Data+%E2%80%94+%2Fv1%2Fdata\u0026amp;title=Get+a+data+store\u0026amp;description=Returns+everything+the+store+declares+%E2%80%94+its+typed+fields%2C+its+record+key%2C+the+complete+set+of+sources+that+may+write+to+it+%E2%80%94+plus+the+precedence+in+effect+for+y\u0026amp;theme=b6a8f417cb6da704c51ca7d7\u0026amp;signature=85e0f52a9225fc446843a603c5de683603df58b64d2de9cd76d2f5cd7bf2c4ff\">\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/getdialed/W4q54Y-ijV9_76KA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"GetDialed Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F46E5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getdialed.ai/api-reference/data-stores/get-a-data-store\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/data-stores/get-a-data-store.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getdialed.ai/#organization\",\"name\":\"GetDialed Docs\",\"url\":\"https://docs.getdialed.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/getdialed/aL0yqdSUKnvM2urY/logo/light.svg?fit=max\u0026auto=format\u0026n=aL0yqdSUKnvM2urY\u0026q=85\u0026s=f6bd462ed94234572b2ef5546432f2e6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getdialed.ai#website\",\"name\":\"GetDialed Docs\",\"url\":\"https://docs.getdialed.ai\",\"publisher\":{\"@id\":\"https://docs.getdialed.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getdialed.ai/api-reference/data-stores/get-a-data-store#webpage\",\"url\":\"https://docs.getdialed.ai/api-reference/data-stores/get-a-data-store\",\"name\":\"Get a data store\",\"description\":\"Returns everything the store declares — its typed fields, its record key, the complete set of sources that may write to it — plus the precedence in effect for your account, how many records are still awaiting recompute, how far the store is behind the current reference-data generation, how much of its carrier data came from a per-number lookup rather than an area-code estimate, and how many of its numbers cannot receive a callback. An unknown store returns 404.\",\"dateModified\":\"2026-10-22T15:46:43.715Z\",\"isPartOf\":{\"@id\":\"https://docs.getdialed.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getdialed.ai/api-reference/data-stores/get-a-data-store#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getdialed.ai/api-reference/data-stores/get-a-data-store#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data — /v1/data\",\"item\":\"https://docs.getdialed.ai/api-reference/record-sets/create-a-record-set\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a data store\",\"item\":\"https://docs.getdialed.ai/api-reference/data-stores/get-a-data-store\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getdialed.ai/api-reference/data-stores/get-a-data-store#apireference\",\"headline\":\"Get a data store\",\"name\":\"Get a data store\",\"description\":\"Returns everything the store declares — its typed fields, its record key, the complete set of sources that may write to it — plus the precedence in effect for your account, how many records are still awaiting recompute, how far the store is behind the current reference-data generation, how much of its carrier data came from a per-number lookup rather than an area-code estimate, and how many of its numbers cannot receive a callback. An unknown store returns 404.\",\"url\":\"https://docs.getdialed.ai/api-reference/data-stores/get-a-data-store\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getdialed.ai/api-reference/data-stores/get-a-data-store#webpage\"},\"dateModified\":\"2026-10-22T15:46:43.715Z\",\"publisher\":{\"@id\":\"https://docs.getdialed.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getdialed.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"GetDialed Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"GetDialed Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API introduction","href":"/api-reference/introduction"},{"title":"Dispatch pause \u0026 resume","href":"/api-reference/dispatch-pause"},{"title":"Change a batch's priority or pacing","href":"/api-reference/batch-patch"}]},{"group":"Flows — /v1/flows","pages":[{"group":"Definitions","pages":[{"title":"List definitions","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/definitions","href":"/api-reference/definitions/list-definitions"},{"title":"Create a definition","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/definitions","href":"/api-reference/definitions/create-a-definition"},{"title":"Get a definition","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/definitions/{definition_id}","href":"/api-reference/definitions/get-a-definition"},{"title":"Update a definition","deprecated":null,"version":null,"openapi":"/openapi.json put /flows/definitions/{definition_id}","href":"/api-reference/definitions/update-a-definition"},{"title":"Delete a definition","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/definitions/{definition_id}","href":"/api-reference/definitions/delete-a-definition"},{"title":"Trigger a definition","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/definitions/{definition_id}/trigger","href":"/api-reference/definitions/trigger-a-definition"},{"title":"List batches for a definition","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/definitions/{definition_id}/batches","href":"/api-reference/batches/list-batches-for-a-definition"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/templates","href":"/api-reference/templates/list-templates"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/templates/{template_id}","href":"/api-reference/templates/get-a-template"}]},{"group":"Schedules","pages":[{"title":"List schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/schedules","href":"/api-reference/schedules/list-schedules"},{"title":"Create a schedule","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/schedules","href":"/api-reference/schedules/create-a-schedule"},{"title":"Get a schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/schedules/{sched_id}","href":"/api-reference/schedules/get-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/openapi.json patch /flows/schedules/{sched_id}","href":"/api-reference/schedules/update-a-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/schedules/{sched_id}","href":"/api-reference/schedules/delete-a-schedule"}]},{"group":"Triggers","pages":[{"title":"List triggers","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/triggers","href":"/api-reference/triggers/list-triggers"},{"title":"Get a trigger","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/triggers/{trigger_id}","href":"/api-reference/triggers/get-a-trigger"},{"title":"List the batches a trigger spawned","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/triggers/{trigger_id}/batches","href":"/api-reference/triggers/list-the-batches-a-trigger-spawned"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"Get a webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/webhooks/{webhook_id}","href":"/api-reference/webhooks/get-a-webhook"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/openapi.json patch /flows/webhooks/{webhook_id}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/webhooks/{webhook_id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Rotate a webhook signing secret","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/webhooks/{webhook_id}/rotate-secret","href":"/api-reference/webhooks/rotate-a-webhook-signing-secret"},{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/webhooks/{webhook_id}/deliveries","href":"/api-reference/webhooks/list-webhook-deliveries"},{"title":"Receive a webhook (called by your external system)","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/webhooks/{slug}/{webhook_id}","href":"/api-reference/webhooks/receive-a-webhook-called-by-your-external-system"},{"title":"Five9 import callback (called by Five9, not by you)","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/webhooks/five9-import/{slug}/{token}","href":"/api-reference/webhooks/five9-import-callback-called-by-five9-not-by-you"}]},{"group":"Event Subscriptions","pages":[{"title":"List event subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/event-subscriptions","href":"/api-reference/event-subscriptions/list-event-subscriptions"},{"title":"Create an event subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/event-subscriptions","href":"/api-reference/event-subscriptions/create-an-event-subscription"},{"title":"Get an event subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/event-subscriptions/{sub_id}","href":"/api-reference/event-subscriptions/get-an-event-subscription"},{"title":"Delete an event subscription","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/event-subscriptions/{sub_id}","href":"/api-reference/event-subscriptions/delete-an-event-subscription"}]},{"group":"Batches","pages":[{"title":"List account-wide batches","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/batches","href":"/api-reference/batches/list-account-wide-batches"},{"title":"Get a batch","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/batches/{batch_id}","href":"/api-reference/batches/get-a-batch"},{"title":"Change a batch's priority or pacing","deprecated":null,"version":null,"openapi":"/openapi.json patch /flows/batches/{batch_id}","href":"/api-reference/batches/change-a-batchs-priority-or-pacing"},{"title":"Cancel a batch","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/batches/{batch_id}/cancel","href":"/api-reference/batches/cancel-a-batch"},{"title":"Cancel a batch (deprecated)","deprecated":true,"version":null,"openapi":"/openapi.json delete /flows/batches/{batch_id}","href":"/api-reference/batches/cancel-a-batch-deprecated"},{"title":"Pause dispatch for a batch","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/batches/{batch_id}/pause","href":"/api-reference/batches/pause-dispatch-for-a-batch"},{"title":"Resume dispatch for a batch","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/batches/{batch_id}/resume","href":"/api-reference/batches/resume-dispatch-for-a-batch"},{"title":"Requeue a batch's held work","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/batches/{batch_id}/requeue","href":"/api-reference/batches/requeue-a-batchs-held-work"},{"title":"List executions for a batch","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/batches/{batch_id}/executions","href":"/api-reference/executions/list-executions-for-a-batch"},{"title":"Stream batch events (SSE)","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/batches/{batch_id}/stream","href":"/api-reference/streams/stream-batch-events-sse"}]},{"group":"Executions","pages":[{"title":"Get an execution","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/executions/{execution_id}","href":"/api-reference/executions/get-an-execution"},{"title":"Stream execution events (SSE)","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/executions/{execution_id}/stream","href":"/api-reference/streams/stream-execution-events-sse"}]},{"group":"Jobs \u0026 Exports","pages":[{"title":"List account-wide jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/jobs","href":"/api-reference/jobs/list-account-wide-jobs"},{"title":"Get a job","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/jobs/{job_id}","href":"/api-reference/jobs/get-a-job"},{"title":"Request a CSV export of your jobs","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/jobs/export","href":"/api-reference/jobs/request-a-csv-export-of-your-jobs"},{"title":"Get an export and its download URL","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/jobs/exports/{export_id}","href":"/api-reference/jobs/get-an-export-and-its-download-url"}]},{"group":"Variables","pages":[{"title":"List variable sets","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/variables","href":"/api-reference/variables/list-variable-sets"},{"title":"Create a variable set","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/variables","href":"/api-reference/variables/create-a-variable-set"},{"title":"Get a variable set","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/variables/{set_name}","href":"/api-reference/variables/get-a-variable-set"},{"title":"Update or rename a variable set","deprecated":null,"version":null,"openapi":"/openapi.json put /flows/variables/{set_name}","href":"/api-reference/variables/update-or-rename-a-variable-set"},{"title":"Delete a variable set","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/variables/{set_name}","href":"/api-reference/variables/delete-a-variable-set"},{"title":"Add a version to a set","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/variables/{set_name}/versions","href":"/api-reference/variables/add-a-version-to-a-set"},{"title":"Update or rename a version","deprecated":null,"version":null,"openapi":"/openapi.json put /flows/variables/{set_name}/versions/{version_name}","href":"/api-reference/variables/update-or-rename-a-version"},{"title":"Delete a version","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/variables/{set_name}/versions/{version_name}","href":"/api-reference/variables/delete-a-version"}]},{"group":"Dashboard \u0026 Usage","pages":[{"title":"Get the dashboard summary","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/dashboard/summary","href":"/api-reference/dashboard/get-the-dashboard-summary"},{"title":"Get usage analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/usage","href":"/api-reference/usage/get-usage-analytics"}]}]},{"group":"Account — /v1/account","pages":[{"title":"Get current session context","deprecated":null,"version":null,"openapi":"/openapi.json get /account/me","href":"/api-reference/me/get-current-session-context"},{"title":"List API keys","deprecated":null,"version":null,"openapi":"/openapi.json get /account/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /account/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/openapi.json delete /account/api-keys/{key_id}","href":"/api-reference/api-keys/revoke-an-api-key"},{"title":"Mint a stream token","deprecated":null,"version":null,"openapi":"/openapi.json post /account/auth/stream-token","href":"/api-reference/auth/mint-a-stream-token"}]},{"group":"Data — /v1/data","pages":[{"title":"Create a record set","deprecated":null,"version":null,"openapi":"/openapi.json post /data/record-sets","href":"/api-reference/record-sets/create-a-record-set"},{"title":"Get a record set","deprecated":null,"version":null,"openapi":"/openapi.json get /data/record-sets/{record_set_id}","href":"/api-reference/record-sets/get-a-record-set"},{"title":"Upload one chunk of records","deprecated":null,"version":null,"openapi":"/openapi.json post /data/record-sets/{record_set_id}/records","href":"/api-reference/record-sets/upload-one-chunk-of-records"},{"title":"Seal a record set","deprecated":null,"version":null,"openapi":"/openapi.json post /data/record-sets/{record_set_id}/seal","href":"/api-reference/record-sets/seal-a-record-set"},{"title":"List data stores","description":"Lists the data stores available to your account with offset pagination (`limit`/`skip`) and a real `total`. A store's `slug` identifies it in every other store URL. `next_cursor` is always null on this offset endpoint.","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores","href":"/api-reference/data-stores/list-data-stores"},{"title":"Get a data store","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}","href":"/api-reference/data-stores/get-a-data-store"},{"title":"List store records","description":"Lists a store's records as resolved views, newest cursor page first. Filter with repeated `filter=field=value` params on any field the store declares; `total` always describes the same filtered population as the page beside it. Sort with `sort_by`/`order`. Paging is cursor-based (`next_cursor`) because the store is browsed while syncs write to it, and an offset page silently repeats or drops rows under concurrent writes. Layers are not included on the list — read a single record with `include=layers` for provenance.","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}/records","href":"/api-reference/data-stores/list-store-records"},{"title":"Get a store record","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}/records/{key}","href":"/api-reference/data-stores/get-a-store-record"},{"title":"Edit a store record","deprecated":null,"version":null,"openapi":"/openapi.json patch /data/stores/{store}/records/{key}","href":"/api-reference/data-stores/edit-a-store-record"},{"title":"Get a store record's history","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}/records/{key}/history","href":"/api-reference/data-stores/get-a-store-records-history"},{"title":"Get a store's precedence settings","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}/precedence","href":"/api-reference/data-stores/get-a-stores-precedence-settings"},{"title":"Set a store's precedence settings","deprecated":null,"version":null,"openapi":"/openapi.json put /data/stores/{store}/precedence","href":"/api-reference/data-stores/set-a-stores-precedence-settings"},{"title":"Reset a store's precedence settings","deprecated":null,"version":null,"openapi":"/openapi.json delete /data/stores/{store}/precedence","href":"/api-reference/data-stores/reset-a-stores-precedence-settings"}]},{"group":"Catalog — /v1/catalog","pages":[{"title":"List platforms","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/platforms","href":"/api-reference/catalog/list-platforms"},{"title":"Get a platform","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/platforms/{platform_id}","href":"/api-reference/catalog/get-a-platform"},{"title":"List services for a platform","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/platforms/{platform_id}/services","href":"/api-reference/catalog/list-services-for-a-platform"},{"title":"Get a service","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/services/{service_id}","href":"/api-reference/catalog/get-a-service"},{"title":"List actions for a service","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/services/{service_id}/actions","href":"/api-reference/catalog/list-actions-for-a-service"},{"title":"Get an action","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/actions/{action_id}","href":"/api-reference/catalog/get-an-action"}]},{"group":"Credentials — /v1/credentials","pages":[{"title":"List credentials","deprecated":null,"version":null,"openapi":"/openapi.json get /credentials","href":"/api-reference/credentials/list-credentials"},{"title":"Create a credential","deprecated":null,"version":null,"openapi":"/openapi.json post /credentials","href":"/api-reference/credentials/create-a-credential"},{"title":"Get a credential","deprecated":null,"version":null,"openapi":"/openapi.json get /credentials/{credential_id}","href":"/api-reference/credentials/get-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/openapi.json put /credentials/{credential_id}","href":"/api-reference/credentials/update-a-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/openapi.json delete /credentials/{credential_id}","href":"/api-reference/credentials/delete-a-credential"},{"title":"Test credentials without saving them","deprecated":null,"version":null,"openapi":"/openapi.json post /credentials/test","href":"/api-reference/credentials/test-credentials-without-saving-them"},{"title":"Test a saved credential","deprecated":null,"version":null,"openapi":"/openapi.json post /credentials/{credential_id}/test","href":"/api-reference/credentials/test-a-saved-credential"}]},{"group":"Tenants — /v1/tenants","pages":[{"title":"List tenants","deprecated":null,"version":null,"openapi":"/openapi.json get /tenants","href":"/api-reference/tenants/list-tenants"},{"title":"Get a tenant","deprecated":null,"version":null,"openapi":"/openapi.json get /tenants/{tenancy_id}","href":"/api-reference/tenants/get-a-tenant"},{"title":"Rename a tenant","deprecated":null,"version":null,"openapi":"/openapi.json patch /tenants/{tenancy_id}","href":"/api-reference/tenants/rename-a-tenant"},{"title":"Retire a tenant","deprecated":null,"version":null,"openapi":"/openapi.json delete /tenants/{tenancy_id}","href":"/api-reference/tenants/retire-a-tenant"}]},{"group":"Five9 Domains — /v1/platforms/five9","pages":[{"title":"List Five9 Domains","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains","href":"/api-reference/five9-domains/list-five9-domains"},{"title":"Get a Five9 Domain","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}","href":"/api-reference/five9-domains/get-a-five9-domain"},{"title":"Update a Five9 Domain's margins and lanes","deprecated":null,"version":null,"openapi":"/openapi.json patch /platforms/five9/domains/{tenancy_id}","href":"/api-reference/five9-domains/update-a-five9-domains-margins-and-lanes"},{"title":"Read a Domain's remaining budget per bucket","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}/headroom","href":"/api-reference/five9-domains/read-a-domains-remaining-budget-per-bucket"},{"title":"Read a Domain's queue depth and estimated completion","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}/queue","href":"/api-reference/five9-domains/read-a-domains-queue-depth-and-estimated-completion"},{"title":"Read a Domain's recent rate-limit usage history","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}/usage","href":"/api-reference/five9-domains/read-a-domains-recent-rate-limit-usage-history"},{"title":"Read per-credential budget attribution for a Domain","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}/attribution","href":"/api-reference/five9-domains/read-per-credential-budget-attribution-for-a-domain"},{"title":"Estimate what an upload will cost against a Domain's budget","deprecated":null,"version":null,"openapi":"/openapi.json post /platforms/five9/domains/{tenancy_id}/estimate","href":"/api-reference/five9-domains/estimate-what-an-upload-will-cost-against-a-domains-budget"},{"title":"Refresh a Five9 Domain's live limits","deprecated":null,"version":null,"openapi":"/openapi.json post /platforms/five9/domains/{tenancy_id}/refresh-limits","href":"/api-reference/five9-domains/refresh-a-five9-domains-live-limits"},{"title":"Pause dispatch for a Five9 Domain","deprecated":null,"version":null,"openapi":"/openapi.json post /platforms/five9/domains/{tenancy_id}/pause","href":"/api-reference/five9-domains/pause-dispatch-for-a-five9-domain"},{"title":"Resume dispatch for a Five9 Domain","deprecated":null,"version":null,"openapi":"/openapi.json post /platforms/five9/domains/{tenancy_id}/resume","href":"/api-reference/five9-domains/resume-dispatch-for-a-five9-domain"},{"title":"List everything holding this Domain's dispatch","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}/pauses","href":"/api-reference/five9-domains/list-everything-holding-this-domains-dispatch"},{"title":"Extend a Domain pause's scheduled resume","deprecated":null,"version":null,"openapi":"/openapi.json patch /platforms/five9/domains/{tenancy_id}/pauses/{pause_id}","href":"/api-reference/five9-domains/extend-a-domain-pauses-scheduled-resume"}]},{"group":"Admin — /v1/admin","pages":[{"title":"Reference data status","href":"/api-reference/reference-status"},{"title":"Pause all dispatch (break-glass)","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/dispatch/pause","href":"/api-reference/dispatch/pause-all-dispatch-break-glass"},{"title":"Resume all dispatch (break-glass)","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/dispatch/resume","href":"/api-reference/dispatch/resume-all-dispatch-break-glass"},{"title":"List everything holding dispatch","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/dispatch/pauses","href":"/api-reference/dispatch/list-everything-holding-dispatch"},{"title":"Get one pause record","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/dispatch/pauses/{pause_id}","href":"/api-reference/dispatch/get-one-pause-record"},{"title":"Reference data freshness","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/reference/status","href":"/api-reference/reference-data/reference-data-freshness"},{"title":"Inbound delivery counts by status","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/vendor-deliveries/counts","href":"/api-reference/vendor-deliveries/inbound-delivery-counts-by-status"}]}]}]},"basePath":"","title":"Get a data store - GetDialed Docs","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}