{ "projectId": "123e4567-e89b-12d3-a456-426614174000", "integrationId": "113e9685-9a51-42cc-8662-9d9725b17f14", "installationId": "66438162-5299-4669-a41d-85c5a3b1a83e", "configId": "a1b2c3d4-e5f6-4789-a012-3456789abcde", "actionType": "read", "status": "success", "id": "3efc0f0f-4bb9-498f-996c-9893d98ca4b5", "result": "[contact] No new data found", "metadata": { "objects": [ "contact" ] }, "createTime": "2023-07-13T21:34:44.816354Z"}
Operation
Get an operation
Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.
GET
/
projects
/
{projectIdOrName}
/
operations
/
{operationId}
Get an operation
curl --request GET \ --url https://api.ampersand.ai/v1/projects/{projectIdOrName}/operations/{operationId} \ --header 'X-Api-Key: <api-key>'
{ "projectId": "123e4567-e89b-12d3-a456-426614174000", "integrationId": "113e9685-9a51-42cc-8662-9d9725b17f14", "installationId": "66438162-5299-4669-a41d-85c5a3b1a83e", "configId": "a1b2c3d4-e5f6-4789-a012-3456789abcde", "actionType": "read", "status": "success", "id": "3efc0f0f-4bb9-498f-996c-9893d98ca4b5", "result": "[contact] No new data found", "metadata": { "objects": [ "contact" ] }, "createTime": "2023-07-13T21:34:44.816354Z"}
Authorizations
APIKeyHeaderBearer
X-Api-Key
string
header
required
Path Parameters
projectIdOrName
string
required
The Ampersand project ID or project name.
operationId
string
required
Unique identifier for the operation. Obtain from the list operations API endpoint, the Ampersand dashboard, or webhook payloads.
Response
The operation, including its current status, result summary, and metadata (e.g. read progress or write results).
projectId
string
required
The Ampersand project ID.
Example:
"123e4567-e89b-12d3-a456-426614174000"
integrationId
string
required
The integration ID.
configId
string
required
The config ID.
Example:
"a1b2c3d4-e5f6-4789-a012-3456789abcde"
actionType
string
required
The type of action that was performed (read, write, or subscribe).
Example:
"read"
id
string
required
Unique identifier for this operation. Use this to fetch operation details or list logs for debugging.
installationId
string
required
The Ampersand installation ID (customer instance) that this operation ran for.
status
string
required
The status of the operation.
success: The operation completed successfully
failure: The operation failed
in_progress: The operation is currently running
Example:
"success"
result
string
A human-readable summary of what the operation accomplished. Examples: [contact] No new data found, Batch write completed (3 succeeded, 1 failed). May be absent.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ampersand","colors":{"primary":"#1F71D6","light":"#F3F89B","dark":"#2B2B2B"},"logo":{"light":"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/light.png?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=7799b7c055eff93e5275bfee4335494b","dark":"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/dark.png?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=e83684af7f0f30de3c40d300c6e38ecf","href":"https://www.ampersand.ai"},"favicon":"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/favicon.svg?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=a58cf520454ff09433cb78f5ce10b2f2","api":{"openapi":["platform.json","read.json","write.json","search.json"]},"background":{"color":{"light":"#FDFBF9","dark":"#121212"}},"navbar":{"links":[{"href":"https://dashboard.withampersand.com/sign-in?trk=docs","label":"Sign in"}],"primary":{"type":"button","label":"Start building now","href":"https://dashboard.withampersand.com/sign-up?trk=docs"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/withampersand","twitter":"https://twitter.com/withampersand"}},"seo":{"indexing":"all"},"fonts":{"heading":{"family":"Helvetica Neue","weight":600,"source":"fonts/HelveticaNeue/HelveticaNeueMedium.woff2","format":"woff2"},"body":{"family":"Helvetica Neue","weight":500,"source":"fonts/HelveticaNeue/HelveticaNeueRoman.woff2","format":"woff2"}},"styling":{"codeblocks":"dark","latex":false},"integrations":{"gtm":{"tagId":"GTM-KKG4NLZD"}},"contextual":{"options":["copy","view"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ampersand-24eb5c1a","hasAudioNarration":false,"actualSubdomain":"ampersand-24eb5c1a","customDomains":["docs.ampersand.ai"],"gitSource":{"type":"github","owner":"amp-labs","repo":"docs","deployBranch":"main","contentDirectory":"src","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afba4d88ec88c31b27205a9","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Integrations","count":434},{"language":"default","tag":"All providers","count":203},{"language":"default","tag":"API Reference","count":91},{"language":"default","tag":"PLATFORM API","count":82},{"language":"default","tag":"Guides","count":37},{"language":"default","tag":"Customer guides","count":13},{"language":"default","tag":"Destinations","count":13},{"language":"default","tag":"Destination","count":12},{"language":"default","tag":"Org","count":12},{"language":"default","tag":"Installation","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"troubleshooting.css","content":".amp-ts{margin-top:1.5rem;letter-spacing:-0.0125rem}.amp-ts [hidden]{display:none!important}.amp-ts-controls{display:flex;flex-wrap:wrap;gap:10px;align-items:center}.amp-ts input.amp-ts-search{flex:1;min-width:240px;height:38px;padding:0 12px;border-radius:12px;border:1px solid var(--amp-border);background:var(--amp-surface-2);color:var(--amp-fg);font-size:15px;outline:none;transition:border-color 120ms ease}.amp-ts input.amp-ts-search:focus{border-color:var(--amp-accent)}.amp-ts input.amp-ts-search::placeholder{color:var(--amp-faint)}.amp-ts-chips{display:flex;flex-wrap:wrap;gap:8px}.amp-ts button.amp-ts-chip{height:32px;padding:0 12px;border:1px solid var(--amp-border);border-radius:12px;background:var(--amp-surface);color:var(--amp-muted);font-size:14px;font-family:inherit;cursor:pointer;transition:border-color 120ms ease, color 120ms ease}.amp-ts button.amp-ts-chip:hover{border-color:var(--amp-border-hover);color:var(--amp-fg)}.amp-ts button.amp-ts-chip.is-active{border-color:var(--amp-accent);color:var(--amp-accent)}.amp-ts-list{margin-top:6px}.amp-ts a.amp-ts-row{display:grid;grid-template-columns:minmax(0, 1fr) auto;align-items:center;gap:16px;padding:14px 4px;border-bottom:1px solid var(--amp-border-2);color:inherit;text-decoration:none;border-radius:0}.amp-ts a.amp-ts-row:hover .amp-ts-title{color:var(--amp-accent)}.amp-ts-title{font-size:16px;font-weight:500;color:var(--amp-fg);transition:color 120ms ease}.amp-ts-title code{font-size:13px}.amp-ts-desc{margin-top:4px;font-size:15px;line-height:1.6;color:var(--amp-muted)}.amp-ts-tag{font-family:var(--amp-mono);font-size:12px;color:var(--amp-muted-2);white-space:nowrap}.amp-ts-count{margin-top:12px;font-family:var(--amp-mono);font-size:12px;color:var(--amp-muted-2)}"},{"filePath":"fonts.css","content":"@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueThin.woff2\") format(\"woff2\");font-weight:100;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueLight.woff2\") format(\"woff2\");font-weight:300;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueRoman.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueMedium.woff2\") format(\"woff2\");font-weight:500 600;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueBold.woff2\") format(\"woff2\");font-weight:700;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueBlack.woff2\") format(\"woff2\");font-weight:900;font-style:normal;font-display:swap}"},{"filePath":"provider-grid.css","content":"html[data-current-path=\"/provider-guides/overview\"] #header{display:none}html[data-current-path=\"/provider-guides/overview\"] .mdx-content{max-width:none;margin-top:0}.amp-intg{max-width:1180px;margin:0 auto;color:var(--amp-fg);line-height:1.5}.amp-intg *{box-sizing:border-box}.amp-intg a{color:inherit;text-decoration:none}.amp-find-status,.amp-orbit-core i,.amp-node-label,.amp-intg-card-code,.amp-intg-card-cta{font-family:var(--amp-mono)}.amp-find-status,.amp-intg-head-sub{color:var(--amp-muted-2)}.amp-intg-eyebrow,.amp-intg-title-accent,.amp-intg-card-code,.amp-intg-card-cta{color:var(--amp-accent)}.amp-find-input,.amp-node a,.amp-node-label,.amp-cat-chips a,.amp-intg-card{border:1px solid var(--amp-border);background:var(--amp-surface)}.amp-cat-chips a:hover,.amp-cat-chips a:focus-visible,.amp-intg-card:hover{border-color:var(--amp-border-hover)}.amp-node a:focus-visible,.amp-cat-head:focus-visible{outline:2px solid var(--amp-accent)}.amp-intg-hero{display:grid;grid-template-columns:minmax(0, 1fr) minmax(0, 1.05fr);gap:56px;align-items:center;padding:40px 0 8px}.amp-intg-eyebrow{font-size:14px;font-weight:500;margin-bottom:12px}.amp-intg h1.amp-intg-title{margin:0;font-size:36px;line-height:44px;letter-spacing:-0.025em;font-weight:600;text-wrap:pretty}.amp-intg p.amp-intg-lede{margin:20px 0 0;font-size:16px;line-height:1.6;color:var(--amp-muted);max-width:46ch;text-wrap:pretty}.amp-find{margin-top:28px;max-width:360px}.amp-find-input{width:100%;height:40px;padding:0 12px;border-radius:8px;color:inherit;font:inherit;font-size:14px;outline:none;transition:border-color 120ms ease}.amp-find-input:focus{border-color:var(--amp-accent)}.amp-find-input::placeholder{color:var(--amp-faint)}.amp-find-status{margin-top:10px;font-size:11.5px;min-height:16px}.amp-orbit{position:relative;width:min(100%, 540px);aspect-ratio:1;margin:0 auto;container-type:inline-size}.amp-orbit::before,.amp-orbit::after{content:\"\";position:absolute;left:50%;top:50%;border-radius:50%;border:1px solid var(--amp-border-2);transform:translate(-50%, -50%);pointer-events:none}.amp-orbit::before{width:52cqw;height:52cqw}.amp-orbit::after{width:86cqw;height:86cqw;border-style:dashed}.amp-orbit-core{position:absolute;left:50%;top:50%;width:15cqw;height:15cqw;transform:translate(-50%, -50%);display:flex;flex-direction:column;align-items:center;justify-content:center;border-radius:50%;background:var(--amp-accent);box-shadow:0 10px 30px var(--amp-accent-soft);transition:transform 200ms ease, box-shadow 200ms ease}.amp-intg a.amp-orbit-core{color:#fff}html.dark .amp-intg a.amp-orbit-core{color:var(--amp-surface)}.amp-orbit-core:hover,.amp-orbit-core:focus-visible{transform:translate(-50%, -50%) scale(1.06);box-shadow:0 14px 36px var(--amp-accent-soft)}.amp-orbit-core b{font-size:4.2cqw;font-weight:600;line-height:1}.amp-orbit-core i{font-size:2.1cqw;font-style:normal;opacity:0.88;line-height:1.5}.amp-node{position:absolute;left:50%;top:50%;transform:translate(-50%, -50%)\n rotate(var(--a))\n translate(var(--r))\n rotate(calc(-1 * var(--a)))}.amp-node a{position:relative;display:grid;place-items:center;width:var(--sz);height:var(--sz);border-radius:50%;transition:transform 200ms cubic-bezier(0.34, 1.4, 0.64, 1), border-color 200ms ease}.amp-node--lg{--sz: 15cqw}.amp-node--sm{--sz: 9.5cqw}.amp-node img{width:62%;height:62%;object-fit:contain;border-radius:6px;background:#ffffff;padding:3%;pointer-events:none}.amp-node a:hover,.amp-node a:focus-visible{border-color:var(--amp-accent)}.amp-node--sm a:hover{transform:scale(1.12)}.amp-node a:focus-visible{outline-offset:3px}.amp-node:has(a:hover),.amp-node:has(a:focus-visible){z-index:3}.amp-node-label{position:absolute;top:calc(100% + 7px);left:50%;transform:translateX(-50%) translateY(3px);padding:3px 9px;border-radius:6px;font-size:11.5px;white-space:nowrap;opacity:0;pointer-events:none;transition:opacity 160ms ease, transform 160ms ease}.amp-node a:hover .amp-node-label,.amp-node a:focus-visible .amp-node-label{opacity:1;transform:translateX(-50%) translateY(0)}.amp-intg-section{padding-top:56px}.amp-intg-section--last{padding-bottom:72px}.amp-intg-head{display:flex;align-items:baseline;gap:14px;padding-bottom:18px;border-bottom:1px solid var(--amp-border-2)}.amp-intg h2.amp-intg-head-title{margin:0;font-size:15px;font-weight:600}.amp-intg-head-sub{font-size:13.5px}.amp-cats{margin-top:8px}.amp-cat{border-bottom:1px solid var(--amp-border-3)}.amp-cat-head{display:grid;grid-template-columns:10px minmax(0, 1fr);align-items:center;gap:14px;padding:17px 4px;cursor:pointer;user-select:none}.amp-cat-head:hover .amp-cat-name,.amp-cat-head:hover .amp-intg-head-title{color:var(--amp-accent)}.amp-cat-head:focus-visible{outline-offset:2px;border-radius:4px}.amp-cat-caret{width:0;height:0;border-left:5px solid var(--amp-faint);border-top:4px solid transparent;border-bottom:4px solid transparent;transition:transform 160ms ease}.amp-cat[data-open=\"true\"] .amp-cat-caret{transform:rotate(90deg);border-left-color:var(--amp-accent)}.amp-cat-name{font-size:14.5px;font-weight:500;letter-spacing:-0.005em;transition:color 120ms ease}.amp-cat:not([data-open=\"true\"]) .amp-cat-chips{display:none}.amp-cat-chips{display:flex;flex-wrap:wrap;gap:8px;padding:2px 4px 22px 24px}.amp-cat--section{border-bottom:0}.amp-intg-head.amp-cat-head{display:flex;align-items:baseline;padding:0 0 18px}.amp-cat--section .amp-cat-caret{align-self:center}.amp-cat--section .amp-cat-chips{padding-top:20px}.amp-cat-chips a{display:inline-flex;align-items:center;height:32px;padding:0 12px;border-radius:7px;font-size:13px;color:var(--amp-fg-2);white-space:nowrap;transition:border-color 120ms ease, color 120ms ease}.amp-cat-chips a:hover,.amp-cat-chips a:focus-visible{color:var(--amp-fg)}.amp-intg-cards{display:grid;grid-template-columns:repeat(auto-fit, minmax(260px, 1fr));gap:16px;margin-top:20px}.amp-intg-card{display:block;padding:20px;border-radius:10px;transition:border-color 120ms ease}.amp-intg-card-code{font-size:13.5px}.amp-intg-card-title{margin-top:10px;font-size:15px;font-weight:600;letter-spacing:-0.01em}.amp-intg-card-desc{margin-top:7px;font-size:14px;line-height:1.55;color:var(--amp-muted)}.amp-intg-card-cta{margin-top:14px;font-size:11.5px}@media (max-width: 960px){.amp-intg-hero{grid-template-columns:minmax(0, 1fr);gap:36px}.amp-intg h1.amp-intg-title{font-size:30px;line-height:38px}}@media (max-width: 640px){.amp-intg h1.amp-intg-title{font-size:27px;line-height:34px}.amp-intg-head{flex-direction:column;align-items:flex-start;gap:6px}.amp-cat-chips{padding-left:4px}}@media (prefers-reduced-motion: no-preference){.amp-node a{animation:amp-bob 6s ease-in-out infinite;animation-delay:var(--d, 0s)}.amp-node a:hover,.amp-node a:focus-visible{animation-play-state:paused}.amp-orbit::after{animation:amp-spin 90s linear infinite}}@keyframes amp-bob{0%,100%{translate:0 0}50%{translate:0 -5px}}@keyframes amp-spin{from{transform:translate(-50%, -50%) rotate(0deg)}to{transform:translate(-50%, -50%) rotate(360deg)}}@media (prefers-reduced-motion: reduce){.amp-node a{animation:none;transition:border-color 160ms ease}.amp-node--sm a:hover{transform:none}.amp-orbit::after{animation:none}.amp-cat-caret{transition:none}.amp-orbit-core:hover,.amp-orbit-core:focus-visible{transform:translate(-50%, -50%)}}.amp-cat[hidden],.amp-cat-chips a[hidden]{display:none!important}"},{"filePath":"shared-variables.css","content":":root{--amp-fg: rgb(var(--gray-900));--amp-fg-2: rgb(var(--gray-700));--amp-muted: rgb(var(--gray-600));--amp-muted-2: rgb(var(--gray-500));--amp-faint: rgb(var(--gray-400));--amp-accent: rgb(var(--primary));--amp-accent-hover: rgb(var(--primary-dark));--amp-accent-soft: rgb(var(--primary) / 0.16);--amp-surface: rgb(var(--background-light));--amp-surface-2: rgb(var(--gray-950) / 0.04);--amp-border: rgb(var(--gray-950) / 0.1);--amp-border-2: rgb(var(--gray-950) / 0.07);--amp-border-3: rgb(var(--gray-950) / 0.05);--amp-border-hover: rgb(var(--gray-950) / 0.22);--amp-mono: var(--font-family-mono-custom, var(--font-jetbrains-mono, ui-monospace)),\n \"SF Mono\", SFMono-Regular, Menlo, monospace}html.dark{--amp-fg: rgb(var(--gray-100));--amp-fg-2: rgb(var(--gray-300));--amp-muted: rgb(var(--gray-400));--amp-muted-2: rgb(var(--gray-400));--amp-faint: rgb(var(--gray-500));--amp-accent: rgb(var(--primary-light));--amp-accent-hover: rgb(var(--primary-light));--amp-accent-soft: rgb(var(--primary-light) / 0.22);--amp-surface: rgb(var(--background-dark));--amp-surface-2: rgb(255 255 255 / 0.05);--amp-border: rgb(255 255 255 / 0.13);--amp-border-2: rgb(255 255 255 / 0.09);--amp-border-3: rgb(255 255 255 / 0.07);--amp-border-hover: rgb(255 255 255 / 0.3)}"}],"page":{"pagePath":"reference/operation/get-an-operation","slug":"/reference/operation/get-an-operation","pageMetadata":{"openapi":"platform get /projects/{projectIdOrName}/operations/{operationId}","title":"Get an operation","description":"Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.\n","href":"/reference/operation/get-an-operation"},"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: \"Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.\"\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":{"codeStyling":"dark","config":{},"pageMetadata":{"openapi":"platform get /projects/{projectIdOrName}/operations/{operationId}","title":"Get an operation","description":"Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.\n","href":"/reference/operation/get-an-operation"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ampersand-24eb5c1a/918af64092960fd7/troubleshooting.js","/_mintlify/custom/ampersand-24eb5c1a/0bf41ceae2eadd8d/provider-grid.js","/_mintlify/custom/ampersand-24eb5c1a/8d356ec11ed170d1/analytics.js"],"openApiReferenceData":{"operation":{"summary":"Get an operation","description":"Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.\n","operationId":"getOperation","tags":["Operation"],"parameters":["c2d3697e-52cf-4a37-b6e2-cae800e8f78c","ec8821ae-10ba-4fb9-bf75-b6286fdbba8d"],"responses":{"200":"5d8e3035-28d0-419d-84d5-e6f7aa14c022","default":"7a8f6a2f-00a2-4cf6-ac04-1bd93cea174e"},"method":"get","type":"path","servers":["a45d937e-d53b-40fa-a6c9-c692a08fd546"],"security":["42ffc7b0-867d-4d7b-8bba-a386fba6a1b4","903de518-6c46-437f-a57c-88b1dd1d3ba0"],"path":"/projects/{projectIdOrName}/operations/{operationId}","baseUrlOptions":["https://api.ampersand.ai/v1"],"title":"Get an operation","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c2d3697e-52cf-4a37-b6e2-cae800e8f78c":{"name":"projectIdOrName","in":"path","required":true,"description":"The Ampersand project ID or project name.","schema":{"type":"string","isRequired":true,"description":"The Ampersand project ID or project name.","uniqueKey":"","typeLabel":"string"},"example":"my-project"},"ec8821ae-10ba-4fb9-bf75-b6286fdbba8d":{"name":"operationId","in":"path","required":true,"description":"Unique identifier for the operation. Obtain from the list operations API endpoint, the Ampersand dashboard, or webhook payloads.","schema":{"type":"string","isRequired":true,"description":"Unique identifier for the operation. Obtain from the list operations API endpoint, the Ampersand dashboard, or webhook payloads.","uniqueKey":"","typeLabel":"string"},"example":"3efc0f0f-4bb9-498f-996c-9893d98ca4b5"}},"responses":{"5d8e3035-28d0-419d-84d5-e6f7aa14c022":{"description":"The operation, including its current status, result summary, and metadata (e.g. read progress or write results).","content":{"application/json":{"schema":{"title":"Operation","required":["projectId","integrationId","installationId","configId","actionType","status","id"],"type":"object","properties":{"projectId":{"type":"string","description":"The Ampersand project ID.","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"projectId","typeLabel":"string"},"integrationId":{"type":"string","description":"The integration ID.","isRequired":true,"uniqueKey":"integrationId","typeLabel":"string"},"configId":{"type":"string","description":"The config ID.","example":"a1b2c3d4-e5f6-4789-a012-3456789abcde","isRequired":true,"uniqueKey":"configId","typeLabel":"string"},"actionType":{"type":"string","description":"The type of action that was performed (`read`, `write`, or `subscribe`).\n","example":"read","isRequired":true,"uniqueKey":"actionType","typeLabel":"string"},"id":{"type":"string","description":"Unique identifier for this operation. Use this to fetch operation details or list logs for debugging.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"installationId":{"type":"string","description":"The Ampersand installation ID (customer instance) that this operation ran for.","isRequired":true,"uniqueKey":"installationId","typeLabel":"string"},"status":{"type":"string","description":"The status of the operation.\n- `success`: The operation completed successfully\n- `failure`: The operation failed\n- `in_progress`: The operation is currently running\n","example":"success","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"result":{"type":"string","description":"A human-readable summary of what the operation accomplished. Examples: `[contact] No new data found`, `Batch write completed (3 succeeded, 1 failed)`. May be absent.\n","example":"[contact] No new data found","uniqueKey":"result","typeLabel":"string"},"metadata":{"type":"object","description":"Additional operation details (e.g. objects, retry info, read progress, successfulRecordIds).","properties":{"objects":{"type":"array","items":{"type":"string","uniqueKey":"metadata.objects.items.[INDEX]","typeLabel":"string"},"uniqueKey":"metadata.objects","typeLabel":"string[]"},"retry":{"type":"object","properties":{"attempts":{"type":"integer","uniqueKey":"metadata.retry.attempts","typeLabel":"integer"},"lastAttempt":{"type":"string","format":"date-time","uniqueKey":"metadata.retry.lastAttempt","typeLabel":"string\u003cdate-time>"},"lastNotified":{"type":"string","format":"date-time","uniqueKey":"metadata.retry.lastNotified","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"metadata.retry","typeLabel":"object"},"progress":{"type":"object","description":"Read progress for the operation, reporting records processed and, where available, the estimated total. Present for all read operations.","properties":{"installationId":{"type":"string","uniqueKey":"metadata.progress.installationId","typeLabel":"string"},"objectName":{"type":"string","uniqueKey":"metadata.progress.objectName","typeLabel":"string"},"operationId":{"type":"string","uniqueKey":"metadata.progress.operationId","typeLabel":"string"},"recordsProcessed":{"type":"integer","uniqueKey":"metadata.progress.recordsProcessed","typeLabel":"integer"},"recordsEstimatedTotal":{"type":"integer","description":"Only present for some providers (e.g. Salesforce, HubSpot).","uniqueKey":"metadata.progress.recordsEstimatedTotal","typeLabel":"integer"}},"uniqueKey":"metadata.progress","typeLabel":"object"},"successfulRecordIds":{"type":"array","items":{"type":"string","uniqueKey":"metadata.successfulRecordIds.items.[INDEX]","typeLabel":"string"},"description":"Provider-assigned IDs of successfully created or updated records. Only present for write operations.","uniqueKey":"metadata.successfulRecordIds","typeLabel":"string[]"}},"example":{"objects":["contact"],"progress":{"installationId":"66438162-5299-4669-a41d-85c5a3b1a83e","objectName":"contact","operationId":"3efc0f0f-4bb9-498f-996c-9893d98ca4b5","recordsProcessed":1250,"recordsEstimatedTotal":5000}},"uniqueKey":"metadata","typeLabel":"object"},"createTime":{"type":"string","description":"The time the operation was created.","format":"date-time","example":"2023-07-13T21:34:44.816354Z","uniqueKey":"createTime","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"Operation · object"},"examples":{"readSuccess":{"title":"readSuccess","summary":"Completed read (no new data)","value":{"projectId":"123e4567-e89b-12d3-a456-426614174000","integrationId":"113e9685-9a51-42cc-8662-9d9725b17f14","installationId":"66438162-5299-4669-a41d-85c5a3b1a83e","configId":"a1b2c3d4-e5f6-4789-a012-3456789abcde","actionType":"read","status":"success","id":"3efc0f0f-4bb9-498f-996c-9893d98ca4b5","result":"[contact] No new data found","metadata":{"objects":["contact"]},"createTime":"2023-07-13T21:34:44.816354Z"}},"readProgress":{"title":"readProgress","summary":"Read with progress","value":{"projectId":"123e4567-e89b-12d3-a456-426614174000","integrationId":"113e9685-9a51-42cc-8662-9d9725b17f14","installationId":"66438162-5299-4669-a41d-85c5a3b1a83e","configId":"a1b2c3d4-e5f6-4789-a012-3456789abcde","actionType":"read","status":"in_progress","id":"3efc0f0f-4bb9-498f-996c-9893d98ca4b5","metadata":{"objects":["contact"],"progress":{"installationId":"66438162-5299-4669-a41d-85c5a3b1a83e","objectName":"contact","operationId":"3efc0f0f-4bb9-498f-996c-9893d98ca4b5","recordsProcessed":1250,"recordsEstimatedTotal":5000}},"createTime":"2023-07-13T21:34:44.816354Z"}},"writeSuccess":{"title":"writeSuccess","summary":"Completed write with successful record IDs","value":{"projectId":"123e4567-e89b-12d3-a456-426614174000","integrationId":"113e9685-9a51-42cc-8662-9d9725b17f14","installationId":"66438162-5299-4669-a41d-85c5a3b1a83e","configId":"a1b2c3d4-e5f6-4789-a012-3456789abcde","actionType":"write","status":"success","id":"7a8b9c0d-1e2f-4a5b-8c9d-0e1f2a3b4c5d","result":"Batch write completed (2 succeeded, 0 failed)","metadata":{"objects":["contact"],"successfulRecordIds":["001xx000003DGbYAAW","001xx000003DGbZAAW"]},"createTime":"2023-07-13T22:10:00.000000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"7a8f6a2f-00a2-4cf6-ac04-1bd93cea174e":{"description":"Error response for any non-2xx status (e.g. operation not found, invalid project or operation ID, or server error).\n","content":{"application/problem+json":{"schema":{"type":"object","title":"API Problem","description":"A Problem Details object (RFC 9457).\n\nAdditional properties specific to the problem type may be present.\n","example":{"type":"urn:problem-type:exampleOrganization:exampleProblem","href":"https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types","title":"Description of the type of problem that occurred","status":400,"detail":"Description of specific occurrence of the problem","instance":"urn:uuid:123e4567-e89b-12d3-a456-426614174000"},"properties":{"type":{"type":"string","format":"uri","description":"An absolute URI that identifies the problem type","default":"about:blank","uniqueKey":"type","typeLabel":"string\u003curi>"},"href":{"type":"string","format":"uri","description":"An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).","uniqueKey":"href","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).","example":"Service Unavailable","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","format":"int32","description":"The HTTP status code generated by the origin server for this occurrence of the problem.","minimum":400,"maximum":600,"exclusiveMaximum":true,"example":503,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","uniqueKey":"instance","typeLabel":"string\u003curi>"},"subsystem":{"type":"string","description":"The subsystem that generated the problem","example":"api","uniqueKey":"subsystem","typeLabel":"string"},"time":{"type":"string","format":"date-time","description":"The time the problem occurred, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"time","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","description":"A unique identifier for the request, useful for debugging","example":"89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715","uniqueKey":"requestId","typeLabel":"string"},"causes":{"type":"array","items":{"type":"string","description":"A brief description of something which caused the problem","example":"database connection failed","uniqueKey":"causes.items.[INDEX]","typeLabel":"string"},"example":["database connection failed","database query failed","unable to fetch user"],"description":"A list of problems that caused this problem. This can be used to represent multiple\nroot causes. There is no guaranteed ordering of the causes.\n","uniqueKey":"causes","typeLabel":"string[]"},"remedy":{"type":"string","description":"A brief description of how to resolve the problem","example":"Shorten your input to be under 100 characters","uniqueKey":"remedy","typeLabel":"string"},"supportEmail":{"type":"string","format":"email","description":"An email address to contact for support","example":"support@withampersand.com","uniqueKey":"supportEmail","typeLabel":"string\u003cemail>"},"supportPhone":{"type":"string","description":"A phone number to contact for support","example":"+1-555-555-5555","uniqueKey":"supportPhone","typeLabel":"string"},"supportUrl":{"type":"string","format":"uri","description":"A URL to contact for support","example":"mailto:support@withampersand.com","uniqueKey":"supportUrl","typeLabel":"string\u003curi>"},"retryable":{"type":"boolean","description":"Whether the request can be retried","example":false,"uniqueKey":"retryable","typeLabel":"boolean"},"retryAfter":{"type":"string","format":"date-time","description":"A timestamp after which the request can be retried, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"retryAfter","typeLabel":"string\u003cdate-time>"},"context":{"type":"object","description":"Additional context for the problem","additionalProperties":true,"example":{"name":"Rick Sanchez"},"uniqueKey":"context","typeLabel":"object"}},"uniqueKey":"","typeLabel":"API Problem · object"},"example":{"type":"https://httpstatuses.com/404","title":"Not Found","status":404,"detail":"Operation not found for the given operation ID.","subsystem":"api","time":"2024-04-22T18:55:28.456076Z","requestId":"89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715","remedy":"Verify the operation ID and project are correct, or list operations to find a valid ID.","retryable":false},"examples":{"Example":{"title":"Example","value":{"type":"https://httpstatuses.com/404","title":"Not Found","status":404,"detail":"Operation not found for the given operation ID.","subsystem":"api","time":"2024-04-22T18:55:28.456076Z","requestId":"89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715","remedy":"Verify the operation ID and project are correct, or list operations to find a valid ID.","retryable":false}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"42ffc7b0-867d-4d7b-8bba-a386fba6a1b4":{"APIKeyHeader":{"type":"apiKey","name":"X-Api-Key","in":"header","scopes":[],"schemeName":"APIKeyHeader"}},"903de518-6c46-437f-a57c-88b1dd1d3ba0":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"}}},"servers":{"a45d937e-d53b-40fa-a6c9-c692a08fd546":{"url":"https://api.ampersand.ai/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-Api-Key","in":"header","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":"Bearer"},"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":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"platform.json"},"subdomain":"ampersand-24eb5c1a","siteName":"Ampersand","title":"Get an operation - Ampersand","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-22T23:20:11.713Z","originalFileLocation":"reference/operation/get-an-operation.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=\"Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ampersand\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_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/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_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/ampersand-24eb5c1a/IC0DrawDowD95AhT/_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/ampersand-24eb5c1a/IC0DrawDowD95AhT/_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/ampersand-24eb5c1a/IC0DrawDowD95AhT/_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/ampersand-24eb5c1a/IC0DrawDowD95AhT/_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/ampersand-24eb5c1a/IC0DrawDowD95AhT/_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/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an operation - Ampersand\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ampersand\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ampersand.ai/reference/operation/get-an-operation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ampersand-24eb5c1a.mintlify.site/_mintlify/api/og/v2?division=Operation\u0026amp;title=Get+an+operation\u0026amp;description=Retrieve+a+single+operation+by+ID.+An+operation+represents+an+async+read%2C+write%2C+or+subscribe+action+for+an+installation.+Use+this+endpoint+to+poll+for+status%2C+\u0026amp;theme=9c317003eb22ad486143ef26\u0026amp;signature=1c2fb11fa773fba791a7eb0bbfba81202c0a6f5944ade60a410d0053ae01ce07\">\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 an operation - Ampersand\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ampersand-24eb5c1a.mintlify.site/_mintlify/api/og/v2?division=Operation\u0026amp;title=Get+an+operation\u0026amp;description=Retrieve+a+single+operation+by+ID.+An+operation+represents+an+async+read%2C+write%2C+or+subscribe+action+for+an+installation.+Use+this+endpoint+to+poll+for+status%2C+\u0026amp;theme=9c317003eb22ad486143ef26\u0026amp;signature=1c2fb11fa773fba791a7eb0bbfba81202c0a6f5944ade60a410d0053ae01ce07\">\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/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ampersand\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F71D6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ampersand.ai/reference/operation/get-an-operation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/operation/get-an-operation.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ampersand.ai/#organization\",\"name\":\"Ampersand\",\"url\":\"https://docs.ampersand.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/light.png?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=7799b7c055eff93e5275bfee4335494b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ampersand.ai#website\",\"name\":\"Ampersand\",\"url\":\"https://docs.ampersand.ai\",\"publisher\":{\"@id\":\"https://docs.ampersand.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ampersand.ai/reference/operation/get-an-operation#webpage\",\"url\":\"https://docs.ampersand.ai/reference/operation/get-an-operation\",\"name\":\"Get an operation\",\"description\":\"Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.\",\"dateModified\":\"2026-05-22T23:20:11.713Z\",\"isPartOf\":{\"@id\":\"https://docs.ampersand.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ampersand.ai/reference/operation/get-an-operation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ampersand.ai/reference/operation/get-an-operation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"PLATFORM API\",\"item\":\"https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Operation\",\"item\":\"https://docs.ampersand.ai/reference/operation/list-operations\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get an operation\",\"item\":\"https://docs.ampersand.ai/reference/operation/get-an-operation\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ampersand.ai/reference/operation/get-an-operation#apireference\",\"headline\":\"Get an operation\",\"name\":\"Get an operation\",\"description\":\"Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.\",\"url\":\"https://docs.ampersand.ai/reference/operation/get-an-operation\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ampersand.ai/reference/operation/get-an-operation#webpage\"},\"dateModified\":\"2026-05-22T23:20:11.713Z\",\"publisher\":{\"@id\":\"https://docs.ampersand.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ampersand.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ampersand\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Ampersand\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/operation/get-an-operation.md","siteName":"Ampersand","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Ampersand REST APIs: Write, Read, Platform, and Proxy","sidebarTitle":"Overview","href":"/api/overview"},{"title":"Access via API key","href":"/api/key-auth"},{"title":"Access via JWT","href":"/api/jwt-auth"}]},{"group":"WRITE API","pages":[{"group":"Write","pages":[{"openapi":"write post /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}","title":"Write records","href":"/reference/write/write-records"}]}]},{"group":"READ API","pages":[{"group":"Read","pages":[{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}","title":"Trigger a read","href":"/reference/read/trigger-a-read"},{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:pause","title":"Pause reads for an installation","href":"/reference/read/pause-reads-for-an-installation"},{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:unpause","title":"Unpause reads for an installation","href":"/reference/read/unpause-reads-for-an-installation"},{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}:deliverResults","title":"Deliver results","href":"/reference/read/deliver-results"}]}]},{"group":"SEARCH API","pages":[{"group":"Search","pages":[{"openapi":"search post /projects/{projectIdOrName}/integrations/{integrationId}","title":"Search records","href":"/reference/search/search-records"}]}]},{"group":"PLATFORM API","pages":[{"group":"OAuth","pages":[{"openapi":"platform post /oauth-connect","title":"Generate OAuth authorization URL","href":"/reference/oauth/generate-oauth-authorization-url"},{"openapi":"platform patch /projects/{projectIdOrName}/connections/{connectionId}:oauth-update","title":"Generate OAuth authorization URL for existing connection","href":"/reference/oauth/generate-oauth-authorization-url-for-existing-connection"}]},{"group":"Connection","pages":[{"openapi":"platform post /custom-auth/connect","title":"Start or continue a multi-step custom auth flow","href":"/reference/connection/start-or-continue-a-multi-step-custom-auth-flow"},{"openapi":"platform get /projects/{projectIdOrName}/connections","title":"List connections","href":"/reference/connection/list-connections"},{"openapi":"platform post /projects/{projectIdOrName}/connections:generate","title":"Generate a new connection","href":"/reference/connection/generate-a-new-connection"},{"openapi":"platform get /projects/{projectIdOrName}/connections/{connectionId}","title":"Get a connection","href":"/reference/connection/get-a-connection"},{"openapi":"platform delete /projects/{projectIdOrName}/connections/{connectionId}","title":"Delete a connection","href":"/reference/connection/delete-a-connection"},{"openapi":"platform patch /projects/{projectIdOrName}/connections/{connectionId}","title":"Update a connection.","href":"/reference/connection/update-a-connection"}]},{"group":"Project","pages":[{"openapi":"platform get /projects","title":"List projects","href":"/reference/project/list-projects"},{"openapi":"platform post /projects","title":"Create a new project","href":"/reference/project/create-a-new-project"},{"openapi":"platform get /projects/{projectIdOrName}","title":"Get a project","href":"/reference/project/get-a-project"},{"openapi":"platform patch /projects/{projectIdOrName}","title":"Update a project","href":"/reference/project/update-a-project"}]},{"group":"Provider App","pages":[{"openapi":"platform get /projects/{projectIdOrName}/provider-apps","title":"List provider apps","href":"/reference/provider-app/list-provider-apps"},{"openapi":"platform post /projects/{projectIdOrName}/provider-apps","title":"Create a new provider app","href":"/reference/provider-app/create-a-new-provider-app"},{"openapi":"platform delete /projects/{projectIdOrName}/provider-apps/{providerAppId}","title":"Delete a provider app.","href":"/reference/provider-app/delete-a-provider-app"},{"openapi":"platform patch /projects/{projectIdOrName}/provider-apps/{providerAppId}","title":"Update a provider app","href":"/reference/provider-app/update-a-provider-app"}]},{"group":"Integration","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations","title":"List integrations","href":"/reference/integration/list-integrations"},{"openapi":"platform post /projects/{projectIdOrName}/integrations","title":"Create a new integration.","href":"/reference/integration/create-a-new-integration"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationIdOrName}","title":"Get an integration by ID or name","href":"/reference/integration/get-an-integration-by-id-or-name"},{"openapi":"platform delete /projects/{projectIdOrName}/integrations/{integrationIdOrName}","title":"Delete an integration","href":"/reference/integration/delete-an-integration"},{"openapi":"platform put /projects/{projectIdOrName}/integrations:batch","title":"Batch upsert a group of integrations","href":"/reference/integration/batch-upsert-a-group-of-integrations"}]},{"group":"Revision","pages":[{"openapi":"platform post /projects/{projectIdOrName}/integrations/{integrationId}/revisions","title":"Create a new revision.","href":"/reference/revision/create-a-new-revision"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/revisions/{revisionId}:hydrate","title":"Get a hydrated revision","href":"/reference/revision/get-a-hydrated-revision"}]},{"group":"Installation","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations","title":"List installations for an integration","href":"/reference/installation/list-installations-for-an-integration"},{"openapi":"platform post /projects/{projectIdOrName}/integrations/{integrationId}/installations","title":"Create a new installation","href":"/reference/installation/create-a-new-installation"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}","title":"Get an installation","href":"/reference/installation/get-an-installation"},{"openapi":"platform delete /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}","title":"Delete an installation","href":"/reference/installation/delete-an-installation"},{"openapi":"platform patch /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}","title":"Update an installation","href":"/reference/installation/update-an-installation"},{"openapi":"platform patch /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/config-content","title":"Update an installation object","href":"/reference/installation/update-an-installation-object"},{"openapi":"platform get /projects/{projectIdOrName}/installations","title":"List installations for a project","href":"/reference/installation/list-installations-for-a-project"}]},{"group":"Objects \u0026 Fields","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/metadata","title":"Get object metadata via installation","href":"/reference/objects-\u0026-fields/get-object-metadata-via-installation"},{"openapi":"platform get /projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata","title":"Get object metadata via connection","href":"/reference/objects-\u0026-fields/get-object-metadata-via-connection"},{"openapi":"platform put /projects/{projectIdOrName}/integrations/{integrationId}/object-metadata","title":"Upsert custom fields for installation","href":"/reference/objects-\u0026-fields/upsert-custom-fields-for-installation"},{"openapi":"platform put /projects/{projectIdOrName}/providers/{provider}/object-metadata","title":"Upsert custom fields for connection","href":"/reference/objects-\u0026-fields/upsert-custom-fields-for-connection"}]},{"group":"Operation","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}/operations","title":"List operations","href":"/reference/operation/list-operations"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}/objects/{objectName}/backfill-progress","title":"Get backfill progress","description":"Retrieve backfill progress (records processed, estimated total) for an object. Use to track progress of an initial data sync.","href":"/reference/operation/get-backfill-progress"},{"openapi":"platform get /projects/{projectIdOrName}/operations/{operationId}","title":"Get an operation","href":"/reference/operation/get-an-operation"},{"openapi":"platform get /projects/{projectIdOrName}/operations/{operationId}/logs","title":"List logs for an operation","description":null,"href":"/reference/operation/list-logs-for-an-operation"}]},{"group":"Provider","pages":[{"openapi":"platform get /providers","title":"List providers","href":"/reference/provider/list-providers"},{"openapi":"platform get /providers/{provider}","title":"Get provider","href":"/reference/provider/get-provider"}]},{"group":"API Key","pages":[{"openapi":"platform get /projects/{projectIdOrName}/api-keys","title":"List API keys","href":"/reference/api-key/list-api-keys"},{"openapi":"platform post /projects/{projectIdOrName}/api-keys","title":"Create a new API key","href":"/reference/api-key/create-a-new-api-key"},{"openapi":"platform get /projects/{projectIdOrName}/api-keys/{apiKey}","title":"Get an API key","href":"/reference/api-key/get-an-api-key"},{"openapi":"platform delete /projects/{projectIdOrName}/api-keys/{apiKey}","title":"Delete an API key","href":"/reference/api-key/delete-an-api-key"},{"openapi":"platform patch /projects/{projectIdOrName}/api-keys/{apiKey}","title":"Update an API key","href":"/reference/api-key/update-an-api-key"}]},{"group":"Destination","pages":[{"openapi":"platform get /projects/{projectIdOrName}/destinations","title":"List destinations","href":"/reference/destination/list-destinations"},{"openapi":"platform post /projects/{projectIdOrName}/destinations","title":"Create a new destination","href":"/reference/destination/create-a-new-destination"},{"openapi":"platform get /projects/{projectIdOrName}/destinations/{destination}","title":"Get a destination","href":"/reference/destination/get-a-destination"},{"openapi":"platform delete /projects/{projectIdOrName}/destinations/{destination}","title":"Delete a destination","href":"/reference/destination/delete-a-destination"},{"openapi":"platform patch /projects/{projectIdOrName}/destinations/{destination}","title":"Update a destination","href":"/reference/destination/update-a-destination"},{"openapi":"platform get /projects/{projectIdOrName}/topics","title":"List topics","href":"/reference/destination/list-topics"},{"openapi":"platform post /projects/{projectIdOrName}/topics","title":"Create a topic","href":"/reference/destination/create-a-topic"},{"openapi":"platform delete /projects/{projectIdOrName}/topics/{topicId}","title":"Delete a topic","href":"/reference/destination/delete-a-topic"},{"openapi":"platform patch /projects/{projectIdOrName}/topics/{topicId}","title":"Update a topic","href":"/reference/destination/update-a-topic"},{"openapi":"platform get /projects/{projectIdOrName}/topic-destination-routes","title":"List topic destination routes","href":"/reference/destination/list-topic-destination-routes"},{"openapi":"platform post /projects/{projectIdOrName}/topic-destination-routes","title":"Create a topic destination route","href":"/reference/destination/create-a-topic-destination-route"},{"openapi":"platform delete /projects/{projectIdOrName}/topic-destination-routes/{routeId}","title":"Delete a topic destination route","href":"/reference/destination/delete-a-topic-destination-route"}]},{"group":"Upload URL","pages":[{"openapi":"platform get /generate-upload-url","title":"Generate a signed URL to upload a zip file to.","href":"/reference/upload-url/generate-a-signed-url-to-upload-a-zip-file-to"}]},{"group":"Org","pages":[{"openapi":"platform post /orgs","title":"Create a new organization","href":"/reference/org/create-a-new-organization"},{"openapi":"platform get /orgs/{orgId}","title":"Get an organization","href":"/reference/org/get-an-organization"},{"openapi":"platform patch /orgs/{orgId}","title":"Update an organization","href":"/reference/org/update-an-organization"},{"openapi":"platform get /orgs/{orgId}/builders","title":"List builders for an organization","href":"/reference/org/list-builders-for-an-organization"},{"openapi":"platform get /orgs/{orgId}/invites","title":"List invites for an organization","href":"/reference/org/list-invites-for-an-organization"},{"openapi":"platform post /orgs/{orgId}/invites","title":"Invite a user to an organization","href":"/reference/org/invite-a-user-to-an-organization"},{"openapi":"platform get /orgs/{orgId}/invites/{inviteId}","title":"Get an invite","href":"/reference/org/get-an-invite"},{"openapi":"platform delete /orgs/{orgId}/invites/{inviteId}","title":"Revoke an invite","href":"/reference/org/revoke-an-invite"},{"openapi":"platform post /orgs/{orgId}/memberships","title":"Add user to an organization","href":"/reference/org/add-user-to-an-organization"},{"openapi":"platform get /claimed-domains","title":"Check if a domain is claimed","href":"/reference/org/check-if-a-domain-is-claimed"},{"openapi":"platform post /claimed-domains","title":"Claim a domain","href":"/reference/org/claim-a-domain"},{"openapi":"platform get /orgs/{orgId}/claimed-domains","title":"List organization's claimed domains","href":"/reference/org/list-organizations-claimed-domains"}]},{"group":"User","pages":[{"openapi":"platform get /my-info","title":"Get information about the current user","href":"/reference/user/get-information-about-the-current-user"},{"openapi":"platform post /invites:accept","title":"Accept an invite","href":"/reference/user/accept-an-invite"}]},{"group":"Billing Account","pages":[{"openapi":"platform get /orgs/{orgId}/billingAccount","title":"Get the billing account for an organization","href":"/reference/billing-account/get-the-billing-account-for-an-organization"},{"openapi":"platform post /billingAccounts/{billingAccountId}/portalSession","title":"Create a portal session for a billing account","href":"/reference/billing-account/create-a-portal-session-for-a-billing-account"}]},{"group":"Notification","pages":[{"openapi":"platform get /projects/{projectIdOrName}/notification-event-topic-routes","title":"List notification event-topic routes","href":"/reference/notification/list-notification-event-topic-routes"},{"openapi":"platform post /projects/{projectIdOrName}/notification-event-topic-routes","title":"Create a notification event-topic route","href":"/reference/notification/create-a-notification-event-topic-route"},{"openapi":"platform delete /projects/{projectIdOrName}/notification-event-topic-routes/{routeId}","title":"Delete a notification event-topic route","href":"/reference/notification/delete-a-notification-event-topic-route"}]},{"group":"JWT Key","pages":[{"openapi":"platform get /projects/{projectIdOrName}/jwt-keys","title":"List JWT keys","href":"/reference/jwt-key/list-jwt-keys"},{"openapi":"platform post /projects/{projectIdOrName}/jwt-keys","title":"Create a new JWT key","href":"/reference/jwt-key/create-a-new-jwt-key"},{"openapi":"platform get /projects/{projectIdOrName}/jwt-keys/{keyId}","title":"Get a specific JWT key","href":"/reference/jwt-key/get-a-specific-jwt-key"},{"openapi":"platform delete /projects/{projectIdOrName}/jwt-keys/{keyId}","title":"Delete a JWT key","href":"/reference/jwt-key/delete-a-jwt-key"},{"openapi":"platform patch /projects/{projectIdOrName}/jwt-keys/{keyId}","title":"Update a JWT key","href":"/reference/jwt-key/update-a-jwt-key"}]}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/provider-guides/overview"}]},{"tab":"Troubleshooting","pages":[{"title":"Troubleshooting","href":"/troubleshooting-guides/overview"}]}]},"basePath":"","title":"Get an operation - Ampersand","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}