State of the datalayer for this connection. Null when the datalayer does not apply: the connection is inactive, its API has no datalayer, or the datalayer is not set up for that API on your account.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Chift","colors":{"primary":"#04C28F","light":"#3AF2AE","dark":"#052B2E"},"logo":{"light":"https://mintcdn.com/chift/SsdLyPJfpLncQDvV/logo/light.svg?fit=max\u0026auto=format\u0026n=SsdLyPJfpLncQDvV\u0026q=85\u0026s=b43848bb528c7d184e769b3f620b6a3b","dark":"https://mintcdn.com/chift/SsdLyPJfpLncQDvV/logo/dark.svg?fit=max\u0026auto=format\u0026n=SsdLyPJfpLncQDvV\u0026q=85\u0026s=31e25aa5df3f1a1d04f93f3c5db928b2"},"favicon":"https://mintcdn.com/chift/zDhHILEvsOX-FIP4/favicon.svg?fit=max\u0026auto=format\u0026n=zDhHILEvsOX-FIP4\u0026q=85\u0026s=9ce78a32dbbd106fd70eea5d5cfa6f02","navbar":{"links":[{"href":"/home","label":"Developer Documentation"},{"href":"/help/overview","label":"User Documentation"}],"primary":{"type":"button","label":"Dashboard","href":"https://chift.app"}},"search":{"prompt":"Search or ask... (Boosted by AI)"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"href":"home"},{"language":"fr","href":"fr/help/overview"},{"language":"es","href":"es/help/overview"},{"language":"nl","href":"nl/help/overview"},{"language":"de","href":"de/help/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chift","hasAudioNarration":false,"actualSubdomain":"chift","customDomains":["docs.chift.eu"],"gitSource":{"type":"github","owner":"chift-oneapi","repo":"chift-api-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae04e1c82b6e98d8bab9d4b","collectionId":"b1882d83-ce33-4a9d-a88c-87a75505faf9","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae04e1c82b6e98d8bab9d4b"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae04e1c82b6e98d8bab9d4b","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"en","tag":"Developer Documentation","count":498},{"language":"en","tag":"Connectors","count":300},{"language":"en","tag":"API Reference","count":202},{"language":"en","tag":"Accounting","count":173},{"language":"en","tag":"User Documentation","count":153},{"language":"de","tag":"User Documentation","count":152},{"language":"es","tag":"User Documentation","count":152},{"language":"fr","tag":"User Documentation","count":152},{"language":"nl","tag":"User Documentation","count":152},{"language":"en","tag":"POS","count":119},{"language":"en","tag":"Unified APIs","count":98},{"language":"en","tag":"Invoicing","count":76},{"language":"en","tag":"Concepts","count":55},{"language":"en","tag":"Other","count":52},{"language":"de","tag":"Accounting","count":52},{"language":"es","tag":"Accounting","count":52},{"language":"fr","tag":"Accounting","count":52},{"language":"nl","tag":"Accounting","count":52},{"language":"de","tag":"POS","count":45},{"language":"es","tag":"POS","count":45},{"language":"fr","tag":"POS","count":45},{"language":"nl","tag":"POS","count":45},{"language":"de","tag":"Invoicing","count":26},{"language":"es","tag":"Invoicing","count":26},{"language":"fr","tag":"Invoicing","count":26},{"language":"nl","tag":"Invoicing","count":26},{"language":"de","tag":"Marketplace","count":8},{"language":"es","tag":"Marketplace","count":8},{"language":"fr","tag":"Marketplace","count":8},{"language":"nl","tag":"Marketplace","count":8},{"language":"de","tag":"Payment","count":7},{"language":"es","tag":"Payment","count":7},{"language":"fr","tag":"Payment","count":7},{"language":"nl","tag":"Payment","count":7},{"language":"de","tag":"eCommerce","count":4},{"language":"de","tag":"PMS","count":4},{"language":"de","tag":"Local Agent","count":4},{"language":"de","tag":"Manage my account","count":4},{"language":"es","tag":"eCommerce","count":4},{"language":"es","tag":"PMS","count":4},{"language":"es","tag":"Local Agent","count":4},{"language":"es","tag":"Manage my account","count":4},{"language":"fr","tag":"eCommerce","count":4},{"language":"fr","tag":"PMS","count":4},{"language":"fr","tag":"Local Agent","count":4},{"language":"fr","tag":"Manage my account","count":4},{"language":"nl","tag":"eCommerce","count":4},{"language":"nl","tag":"PMS","count":4},{"language":"nl","tag":"Local Agent","count":4},{"language":"nl","tag":"Manage my account","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"connectors/custom.css","content":"#content-area table td:first-child,#content-area table th:first-child{position:sticky;left:0;z-index:2;background-color:#fff;border-right:1px solid var(--border-subtle)}html.dark #content-area table td:first-child,html.dark #content-area table th:first-child{background-color:#000f06ff}.coverage-table-container{height:70vh;overflow:auto;border:1px solid #ddd;margin:20px 0;position:relative;display:block}.coverage-table-container table{display:table!important;width:100%!important;border-collapse:collapse!important}.coverage-table-container table thead{display:table-header-group!important;position:sticky!important;top:0!important;z-index:10!important;background-color:#fff!important}.coverage-table-container table thead th{background-color:#fff!important;border-bottom:2px solid #ddd!important;padding:8px!important;text-align:left!important}html.dark .coverage-table-container table thead,html.dark .coverage-table-container table thead th{background-color:#000f06ff!important}.coverage-table-container table thead th:first-child{z-index:11!important}"},{"filePath":"style.css","content":"html[data-page-mode=wide] #content-container{max-width:100%}html[data-docs-section=help] .nav-dropdown-trigger,html[data-docs-section=help] .navbar-link{display:none!important}@media (min-width:1024px){.nav-dropdown-trigger{display:none!important}html[data-docs-section=dev] .navbar-link:has(a:not([href*=\"/help\"])){display:none}html[data-docs-section=dev] #localization-select-trigger,html[data-docs-section=help] #topbar-cta-button{display:none}}.cw{--cw-border:rgba(5, 43, 46, 0.12);--cw-muted:rgba(5, 43, 46, 0.6);--cw-chip-bg:rgba(5, 43, 46, 0.04);margin-top:1rem}.dark .cw{--cw-border:rgba(255, 255, 255, 0.12);--cw-muted:rgba(255, 255, 255, 0.6);--cw-chip-bg:rgba(255, 255, 255, 0.04)}.cw-stats{display:grid;grid-template-columns:repeat(3,1fr);gap:.75rem;margin-bottom:1.5rem}.cw-stats>div{border:1px solid var(--cw-border);border-radius:12px;padding:1rem;text-align:center}.cw-stats strong{display:block;font-size:2rem;line-height:1.1;color:#04c28f}.cw-stats span{font-size:.85rem;color:var(--cw-muted)}.cw-chips,.cw-controls{display:flex;flex-wrap:wrap}.cw-controls{gap:.75rem;align-items:center;justify-content:space-between;margin-bottom:1rem}.cw-chips{gap:.4rem}.cw-chip{border:1px solid var(--cw-border);background:var(--cw-chip-bg);border-radius:999px;padding:.3rem .8rem;font-size:.85rem;cursor:pointer}.cw-chip-on{background:#04c28f;border-color:#04c28f;color:#052b2e;font-weight:600}.cw-search{border:1px solid var(--cw-border);background:0 0;border-radius:8px;padding:.4rem .75rem;font-size:.9rem;min-width:0;width:14rem;max-width:100%}.cw-section{margin-top:1.75rem}.cw-head{display:flex;flex-wrap:wrap;align-items:baseline;justify-content:space-between;gap:.5rem;margin-bottom:.75rem}.cw-head h3{margin:0;font-size:1.1rem;font-weight:600}.cw-count{font-size:.8rem;font-weight:500;color:var(--cw-muted);margin-left:.25rem}.cw-more{font-size:.85rem;color:#04c28f}.cw-grid{display:grid;grid-template-columns:repeat(auto-fill,minmax(64px,1fr));gap:.6rem}.cw-tile{position:relative;display:flex;align-items:center;justify-content:center;aspect-ratio:1;background:#fff;border:1px solid var(--cw-border);border-radius:12px;padding:10px;transition:transform .15s ease,box-shadow .15s ease,border-color .15s ease}.cw a.cw-tile{border-bottom:1px solid var(--cw-border);z-index:1}.cw .cw-tile:focus-visible,.cw .cw-tile:hover{transform:translateY(-2px);border:1px solid #04c28f;box-shadow:0 4px 14px rgba(4,194,143,.25);outline:0;z-index:20}.cw-tile-static{cursor:default}.cw-logo{width:100%;height:100%;object-fit:contain;margin:0!important;border-radius:6px}.cw-name{font-weight:700;font-size:.7rem;line-height:1.1;text-align:center;overflow-wrap:anywhere;color:#052b2e}.cw-new,.cw-tip{position:absolute;background:#04c28f;color:#052b2e}.cw-new{top:-7px;right:-7px;border:1px solid #04c28f;border-radius:999px;padding:0 .35rem;font-size:.6rem;font-weight:700;line-height:1.5;letter-spacing:.02em}.dark .cw-new{background:#052b2e;color:#3af2ae;border-color:#04c28f}.cw-tip{bottom:calc(100% + 6px);left:50%;transform:translateX(-50%);white-space:nowrap;font-weight:600;box-shadow:0 2px 8px rgba(0,0,0,.25);font-size:.75rem;padding:.25rem .5rem;border-radius:6px;pointer-events:none;opacity:0;transition:opacity .12s ease}.cw-tile:focus-visible .cw-tip,.cw-tile:hover .cw-tip{opacity:1}.cw-empty{color:var(--cw-muted)}@media (max-width:480px){.cw-stats strong{font-size:1.5rem}.cw-search{width:100%}}"}],"page":{"pagePath":"api-reference/endpoints/connections/get-connections","slug":"/api-reference/endpoints/connections/get-connections","pageMetadata":{"openapi":"get /consumers/{consumer_id}/connections","title":"Get connections","description":"Returns a list of the connections (active or inactive) linked to your consumer","href":"/api-reference/endpoints/connections/get-connections"},"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 a list of the connections (active or inactive) linked to your consumer\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Learn more:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`What is a connection? `,_jsx(_components.a,{href:`/unified-apis/guides/connections`,target:`_blank`,children:`↗`})]}),`\n`,_jsxs(_components.li,{children:[`How to connect to a software? `,_jsx(_components.a,{href:`/unified-apis/guides/end-user-connection`,target:`_blank`,children:`↗`})]}),`\n`,_jsxs(_components.li,{children:[`How to handle activation and redirects? `,_jsx(_components.a,{href:`/unified-apis/guides/activation-and-redirects`,target:`_blank`,children:`↗`})]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /consumers/{consumer_id}/connections","title":"Get connections","description":"Returns a list of the connections (active or inactive) linked to your consumer","href":"/api-reference/endpoints/connections/get-connections"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/chift/f67c86372f363744/custom.js"],"openApiReferenceData":{"operation":{"tags":["Connections"],"summary":"Get connections","description":"Returns a list of the connections (active or inactive) linked to your consumer","operationId":"connections_get_connections","security":["97850fcd-c611-4e2a-b066-3a4f18ed41fd"],"parameters":["3c61a0e7-91ec-47d5-967a-2f89a5fb8fec"],"responses":{"200":"ac7f564a-762b-4473-ad6f-af5061cc9a59","404":"c5c8e954-940f-4fcb-96d3-f0bc08c4bb62","422":"255367c4-c422-47f9-af36-8702d799858e"},"method":"get","type":"path","servers":["5defdfa8-71fb-4ec4-801e-b5f74b591689"],"path":"/consumers/{consumer_id}/connections","baseUrlOptions":["https://api.chift.eu"],"title":"Get connections","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3c61a0e7-91ec-47d5-967a-2f89a5fb8fec":{"name":"consumer_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Consumer Id","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"ac7f564a-762b-4473-ad6f-af5061cc9a59":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"connectionid":{"type":"string","format":"uuid","title":"Connectionid","isRequired":true,"uniqueKey":"items.[INDEX].connectionid","typeLabel":"string\u003cuuid>"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"items.[INDEX].name","typeLabel":"string"},"integration":{"type":"string","title":"Integration","isRequired":true,"uniqueKey":"items.[INDEX].integration","typeLabel":"string"},"integrationid":{"type":"integer","title":"Integrationid","isRequired":true,"uniqueKey":"items.[INDEX].integrationid","typeLabel":"integer"},"api":{"type":"string","title":"Api","isRequired":true,"uniqueKey":"items.[INDEX].api","typeLabel":"string"},"status":{"type":"string","enum":["active","inactive"],"title":"ConnectionStatus","isRequired":true,"uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"data":{"oneOf":[{"type":"object","title":"Data","additionalProperties":true,"uniqueKey":"items.[INDEX].data.oneOf.0","typeLabel":"Data · object"},{"type":"null","title":"Data","uniqueKey":"items.[INDEX].data.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].data","typeLabel":"Data · object | null"},"agent":{"oneOf":[{"type":"object","title":"LocalAgentInfo","description":"For local agent only. Indicates whether the local agent is up and running","required":["status"],"properties":{"status":{"type":"string","enum":["up","down"],"title":"LocalAgentStatus","isRequired":true,"uniqueKey":"items.[INDEX].agent.oneOf.0.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"items.[INDEX].agent.oneOf.0","typeLabel":"LocalAgentInfo · object"},{"type":"null","description":"For local agent only. Indicates whether the local agent is up and running","uniqueKey":"items.[INDEX].agent.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].agent","typeLabel":"LocalAgentInfo · object | null"},"datalayer":{"oneOf":[{"type":"object","title":"DatalayerInfo","description":"State of the datalayer for this connection. Null when the datalayer does not apply: the connection is inactive, its API has no datalayer, or the datalayer is not set up for that API on your account.","required":["status"],"properties":{"status":{"type":"string","enum":["not_enabled","syncing","ready","stale"],"title":"DatalayerStatus","description":"`ready` when reads can be served from the datalayer (`x-chift-datalayer` header). `stale` when its last sync is older than the max staleness set on your account, so reads are refused until the next sync unless they send a larger `x-chift-datalayer-max-staleness`. `syncing` when the datalayer is enabled but its first sync has not finished, so there is nothing to query yet. `not_enabled` when the datalayer is available for this API but not turned on for this consumer.","isRequired":true,"uniqueKey":"items.[INDEX].datalayer.oneOf.0.status","typeLabel":"enum\u003cstring>"},"last_sync_date":{"oneOf":[{"type":"string","title":"Last Sync Date","description":"When the datalayer sync last completed a scope of this connection. Null until one completes.","format":"date-time","uniqueKey":"items.[INDEX].datalayer.oneOf.0.last_sync_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Sync Date","description":"When the datalayer sync last completed a scope of this connection. Null until one completes.","uniqueKey":"items.[INDEX].datalayer.oneOf.0.last_sync_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].datalayer.oneOf.0.last_sync_date","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"items.[INDEX].datalayer.oneOf.0","typeLabel":"DatalayerInfo · object"},{"type":"null","description":"State of the datalayer for this connection. Null when the datalayer does not apply: the connection is inactive, its API has no datalayer, or the datalayer is not set up for that API on your account.","uniqueKey":"items.[INDEX].datalayer.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].datalayer","typeLabel":"DatalayerInfo · object | null"}},"type":"object","required":["connectionid","name","integration","integrationid","api","status"],"title":"ConnectionItem","uniqueKey":"items.[INDEX]","typeLabel":"ConnectionItem · object"},"title":"Response Connections Get Connections","uniqueKey":"","typeLabel":"ConnectionItem · object[]"},"examples":{"Example":{"title":"Example","value":[{"connectionid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","integration":"\u003cstring>","integrationid":123,"api":"\u003cstring>","status":"active","data":{},"agent":{"status":"up"},"datalayer":{"status":"not_enabled","last_sync_date":"2023-11-07T05:31:56Z"}}]}},"exampleType":"generated"}},"exampleType":"generated"},"c5c8e954-940f-4fcb-96d3-f0bc08c4bb62":{"content":{"application/json":{"example":{"message":"The consumer does not exist","status":"error"},"schema":{"properties":{"message":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"oneOf":[{"type":"string","title":"Status","default":"error","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Status","default":"error","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"string | null"},"detail":{"oneOf":[{"type":"string","title":"Detail","default":"","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","default":"","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"error_code":{"oneOf":[{"type":"string","title":"Error Code","uniqueKey":"error_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Error Code","uniqueKey":"error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_code","typeLabel":"string | null"}},"type":"object","required":["message"],"title":"ChiftError","uniqueKey":"","typeLabel":"ChiftError · object"},"examples":{"Example":{"title":"Example","value":{"message":"The consumer does not exist","status":"error"}}},"exampleType":"examples"}},"description":"Not Found","exampleType":"examples"},"255367c4-c422-47f9-af36-8702d799858e":{"description":"Validation Error","content":{"application/json":{"schema":{"title":"Validation Error","required":["message"],"type":"object","properties":{"message":{"title":"Message","type":"string","default":"Validation error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"title":"Status","type":"string","default":"error","uniqueKey":"status","typeLabel":"string"},"detail":{"title":"Detail","type":"array","items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"uniqueKey":"","typeLabel":"Validation Error · object"},"examples":{"Example":{"title":"Example","value":{"message":"Validation error","status":"error","detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"97850fcd-c611-4e2a-b066-3a4f18ed41fd":{"mcp_auth":{"$ref":"43f7c795-0881-48dc-83c5-831b2ab76f25","scopes":["connections","connections.read"]}}},"servers":{"5defdfa8-71fb-4ec4-801e-b5f74b591689":{"url":"https://api.chift.eu","description":"Chift"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"chift","siteName":"Chift","title":"Get connections - Chift","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/endpoints/connections/get-connections","matchLevel":0},"fr":{"href":"/fr/help/overview","matchLevel":4},"es":{"href":"/es/help/overview","matchLevel":4},"nl":{"href":"/nl/help/overview","matchLevel":4},"de":{"href":"/de/help/overview","matchLevel":4}}},"lastModified":"2026-10-19T11:53:54.980Z","originalFileLocation":"api-reference/endpoints/connections/get-connections.mdx","locale":"en"},"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 a list of the connections (active or inactive) linked to your consumer\">\u003cmeta data-mint-head name=\"application-name\" content=\"Chift\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_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/chift/Eooe0Gz14iDrzh6Z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chift/Eooe0Gz14iDrzh6Z/_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/chift/Eooe0Gz14iDrzh6Z/_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/chift/Eooe0Gz14iDrzh6Z/_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/chift/Eooe0Gz14iDrzh6Z/_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/chift/Eooe0Gz14iDrzh6Z/_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/chift/Eooe0Gz14iDrzh6Z/_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/chift/Eooe0Gz14iDrzh6Z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get connections - Chift\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a list of the connections (active or inactive) linked to your consumer\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chift\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.chift.eu/api-reference/endpoints/connections/get-connections\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chift.mintlify.app/_mintlify/api/og/v2?division=Connections\u0026amp;title=Get+connections\u0026amp;description=Returns+a+list+of+the+connections+%28active+or+inactive%29+linked+to+your+consumer\u0026amp;theme=f033b722e138919620599cda\u0026amp;signature=ac7a141d1324dbd41d3b7dd9a64a0c4cd5a8cf1c16534ce6f4d3178b95514905\">\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 connections - Chift\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a list of the connections (active or inactive) linked to your consumer\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chift.mintlify.app/_mintlify/api/og/v2?division=Connections\u0026amp;title=Get+connections\u0026amp;description=Returns+a+list+of+the+connections+%28active+or+inactive%29+linked+to+your+consumer\u0026amp;theme=f033b722e138919620599cda\u0026amp;signature=ac7a141d1324dbd41d3b7dd9a64a0c4cd5a8cf1c16534ce6f4d3178b95514905\">\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/chift/Eooe0Gz14iDrzh6Z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chift\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#04C28F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.chift.eu/api-reference/endpoints/connections/get-connections\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/connections/get-connections.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.chift.eu/#organization\",\"name\":\"Chift\",\"url\":\"https://docs.chift.eu\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chift/SsdLyPJfpLncQDvV/logo/light.svg?fit=max\u0026auto=format\u0026n=SsdLyPJfpLncQDvV\u0026q=85\u0026s=b43848bb528c7d184e769b3f620b6a3b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.chift.eu#website\",\"name\":\"Chift\",\"url\":\"https://docs.chift.eu\",\"publisher\":{\"@id\":\"https://docs.chift.eu/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.chift.eu/api-reference/endpoints/connections/get-connections#webpage\",\"url\":\"https://docs.chift.eu/api-reference/endpoints/connections/get-connections\",\"name\":\"Get connections\",\"description\":\"Returns a list of the connections (active or inactive) linked to your consumer\",\"dateModified\":\"2026-10-19T11:53:54.980Z\",\"isPartOf\":{\"@id\":\"https://docs.chift.eu#website\"},\"breadcrumb\":{\"@id\":\"https://docs.chift.eu/api-reference/endpoints/connections/get-connections#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.chift.eu/api-reference/endpoints/connections/get-connections#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Access \u0026 Connections\",\"item\":\"https://docs.chift.eu/api-reference/endpoints/general/get-access-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Connections\",\"item\":\"https://docs.chift.eu/api-reference/endpoints/connections/add-new-connection\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get connections\",\"item\":\"https://docs.chift.eu/api-reference/endpoints/connections/get-connections\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.chift.eu/api-reference/endpoints/connections/get-connections#apireference\",\"headline\":\"Get connections\",\"name\":\"Get connections\",\"description\":\"Returns a list of the connections (active or inactive) linked to your consumer\",\"url\":\"https://docs.chift.eu/api-reference/endpoints/connections/get-connections\",\"mainEntityOfPage\":{\"@id\":\"https://docs.chift.eu/api-reference/endpoints/connections/get-connections#webpage\"},\"dateModified\":\"2026-10-19T11:53:54.980Z\",\"publisher\":{\"@id\":\"https://docs.chift.eu/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.chift.eu#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Chift\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Chift","nav":{"global":null,"languages":[{"language":"en","default":true,"dropdowns":[{"dropdown":"Developer Documentation","icon":"book-open","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home"}]},{"tab":"Unified APIs","pages":[{"title":"Unified APIs","href":"/unified-apis/overview"}]},{"tab":"Syncs","pages":[{"title":"Syncs","href":"/syncs/overview"}]},{"tab":"API Reference","groups":[{"group":"API Reference Overview","pages":[{"title":null,"href":"/api-reference/overview"}]},{"group":"Access \u0026 Connections","pages":[{"group":"Authentication","pages":[{"openapi":"post /token","title":"Get access token","href":"/api-reference/endpoints/general/get-access-token"}]},{"group":"Consumers","pages":[{"openapi":"post /consumers","title":"Create new consumer","href":"/api-reference/endpoints/consumers/create-new-consumer"},{"openapi":"get /consumers/{consumer_id}","title":"Get one consumer","href":"/api-reference/endpoints/consumers/get-one-consumer"},{"openapi":"get /consumers","title":"Get consumers","href":"/api-reference/endpoints/consumers/get-consumers"},{"openapi":"patch /consumers/{consumer_id}","title":"Update one consumer","href":"/api-reference/endpoints/consumers/update-one-consumer"},{"openapi":"delete /consumers/{consumer_id}","title":"Delete one consumer","href":"/api-reference/endpoints/consumers/delete-one-consumer"}]},{"group":"Connections","pages":[{"openapi":"post /consumers/{consumer_id}/connections","title":"Add new connection","href":"/api-reference/endpoints/connections/add-new-connection"},{"openapi":"get /consumers/{consumer_id}/connections/{connectionid}","title":"Get one connection","description":"Returns the specified connection (active or inactive) of your consumer","href":"/api-reference/endpoints/connections/get-one-connection"},{"openapi":"get /consumers/{consumer_id}/connections","title":"Get connections","href":"/api-reference/endpoints/connections/get-connections"},{"openapi":"patch /consumers/{consumer_id}/connections/{connectionid}","title":"Update an existing connection","description":"Returns the url that can be used by your client to update the connection","href":"/api-reference/endpoints/connections/update-an-existing-connection"},{"openapi":"delete /consumers/{consumer_id}/connections/{connectionid}","title":"Delete one connection","href":"/api-reference/endpoints/connections/delete-one-connection"}]},{"group":"Integrations","pages":[{"openapi":"get /integrations","title":"Get list of integrations","href":"/api-reference/endpoints/integrations/get-list-of-integrations"},{"openapi":"get /integrations/{integrationid}","title":"Get one integration","href":"/api-reference/endpoints/integrations/get-one-integration"},{"openapi":"get /integrations/{integrationid}/{image_type}.json","title":"Get integration logo/icon (as base64)","href":"/api-reference/endpoints/integrations/get-integration-logoicon-as-base64"}]}]},{"group":"Accounting","pages":[{"group":"Folders","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/folders","title":"Get folders","href":"/api-reference/endpoints/accounting/get-folders"},{"openapi":"get /consumers/{consumer_id}/accounting/folders/{folder_id}","title":"Get one folder","href":"/api-reference/endpoints/accounting/get-one-folder"}]},{"group":"Book years","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/bookyears","title":"Get book years","href":"/api-reference/endpoints/accounting/get-book-years"}]},{"group":"Clients","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/clients","title":"Create client","href":"/api-reference/endpoints/accounting/create-client"},{"openapi":"get /consumers/{consumer_id}/accounting/clients/{client_id}","title":"Get one client","href":"/api-reference/endpoints/accounting/get-one-client"},{"openapi":"get /consumers/{consumer_id}/accounting/clients","title":"Get clients","href":"/api-reference/endpoints/accounting/get-clients"},{"openapi":"patch /consumers/{consumer_id}/accounting/clients/{client_id}","title":"Update client","href":"/api-reference/endpoints/accounting/update-client"}]},{"group":"Suppliers","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/suppliers","title":"Create supplier","href":"/api-reference/endpoints/accounting/create-supplier"},{"openapi":"get /consumers/{consumer_id}/accounting/suppliers/{supplier_id}","title":"Get one supplier","href":"/api-reference/endpoints/accounting/get-one-supplier"},{"openapi":"get /consumers/{consumer_id}/accounting/suppliers","title":"Get suppliers","href":"/api-reference/endpoints/accounting/get-suppliers"},{"openapi":"patch /consumers/{consumer_id}/accounting/suppliers/{supplier_id}","title":"Update one supplier","href":"/api-reference/endpoints/accounting/update-one-supplier"}]},{"group":"Invoices","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/invoices","title":"Create sale/purchase entry","href":"/api-reference/endpoints/accounting/create-salepurchase-entry"},{"openapi":"post /consumers/{consumer_id}/accounting/invoices/multi-analytic-plans","title":"Create sale/purchase entry (Multiple plans)","href":"/api-reference/endpoints/accounting/create-salepurchase-entry-multiple-plans"},{"openapi":"get /consumers/{consumer_id}/accounting/invoices/type/{invoice_type}","title":"Get invoices by type (sale/purchase entries)","href":"/api-reference/endpoints/accounting/get-invoices-by-type-salepurchase-entries"},{"openapi":"get /consumers/{consumer_id}/accounting/invoices/{invoice_id}","title":"Get one invoice (sale/purchase entry)","href":"/api-reference/endpoints/accounting/get-one-invoice-salepurchase-entry"},{"openapi":"get /consumers/{consumer_id}/accounting/invoices/multi-analytic-plans/{invoice_id}","title":"Get one invoice (sale/purchase entry - Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/get-one-invoice-salepurchase-entry--multiple-analytic-plans"},{"openapi":"get /consumers/{consumer_id}/accounting/invoices/multi-analytic-plans/type/{invoice_type}","title":"Get invoices by type (sale/purchase entries - Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/get-invoices-by-type-salepurchase-entries--multiple-analytic-plans"},{"openapi":"post /consumers/{consumer_id}/accounting/invoices/payments","title":"Create an invoice payment","href":"/api-reference/endpoints/accounting/create-an-invoice-payment"},{"openapi":"get /consumers/{consumer_id}/accounting/payment-methods","title":"Get payment methods","href":"/api-reference/endpoints/accounting/get-payment-methods"},{"openapi":"get /consumers/{consumer_id}/accounting/payment-terms","title":"Get payment terms","href":"/api-reference/endpoints/accounting/get-payment-terms"}]},{"group":"Banking","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/bank-accounts","title":"Create bank account","href":"/api-reference/endpoints/accounting/create-bank-account"},{"openapi":"get /consumers/{consumer_id}/accounting/bank-accounts","title":"Get bank accounts","href":"/api-reference/endpoints/accounting/get-bank-accounts"},{"openapi":"post /consumers/{consumer_id}/accounting/bank-transactions","title":"Create bank transactions","href":"/api-reference/endpoints/accounting/create-bank-transactions"}]},{"group":"Ledger accounts","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/accounts","title":"Create ledger account","href":"/api-reference/endpoints/accounting/create-ledger-account"},{"openapi":"get /consumers/{consumer_id}/accounting/chart-of-accounts","title":"Get chart of accounts","href":"/api-reference/endpoints/accounting/get-chart-of-accounts"},{"openapi":"post /consumers/{consumer_id}/accounting/chart-of-accounts/balance","title":"Get the balance of accounts","href":"/api-reference/endpoints/accounting/get-the-balance-of-accounts"}]},{"group":"Journals","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/journal","title":"Create journal","href":"/api-reference/endpoints/accounting/create-journal"},{"openapi":"get /consumers/{consumer_id}/accounting/journals","title":"Get journals","href":"/api-reference/endpoints/accounting/get-journals"}]},{"group":"Journal entries","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/journal-entries","title":"Create Journal Entry","href":"/api-reference/endpoints/accounting/create-journal-entry"},{"openapi":"post /consumers/{consumer_id}/accounting/financial-entries","title":"Create a financial entry","href":"/api-reference/endpoints/accounting/create-a-financial-entry"},{"openapi":"get /consumers/{consumer_id}/accounting/journal/entries","title":"Get journal entries","href":"/api-reference/endpoints/accounting/get-journal-entries"},{"openapi":"get /consumers/{consumer_id}/accounting/journal/entries/multi-analytic-plans","title":"Get journal entries (Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/get-journal-entries-multiple-analytic-plans"},{"openapi":"get /consumers/{consumer_id}/accounting/journal/entries/{journal_entry_id}","title":"Get one journal entry","href":"/api-reference/endpoints/accounting/get-one-journal-entry"},{"openapi":"post /consumers/{consumer_id}/accounting/matching","title":"Match entries","href":"/api-reference/endpoints/accounting/match-entries"}]},{"group":"Expenses","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/expenses","deprecated":true,"title":"Create an expense","href":"/api-reference/endpoints/accounting/create-an-expense"}]},{"group":"Employees","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/employees","title":"Get employees","href":"/api-reference/endpoints/accounting/get-employees"}]},{"group":"Analytic plans","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/analytic-plans","title":"Get analytic plans","href":"/api-reference/endpoints/accounting/get-analytic-plans"}]},{"group":"Analytic accounts","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/analytic-accounts","title":"Create analytic account","href":"/api-reference/endpoints/accounting/create-analytic-account"},{"openapi":"post /consumers/{consumer_id}/accounting/analytic-accounts/multi-analytic-plans/{analytic_plan}","title":"Create analytic account (Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/create-analytic-account-multiple-analytic-plans"},{"openapi":"get /consumers/{consumer_id}/accounting/analytic-accounts","title":"Get analytic accounts","href":"/api-reference/endpoints/accounting/get-analytic-accounts"},{"openapi":"get /consumers/{consumer_id}/accounting/analytic-accounts/{analytic_account_id}","title":"Get analytic account","href":"/api-reference/endpoints/accounting/get-analytic-account"},{"openapi":"patch /consumers/{consumer_id}/accounting/analytic-accounts/{analytic_account_id}","title":"Update analytic account","href":"/api-reference/endpoints/accounting/update-analytic-account"},{"openapi":"get /consumers/{consumer_id}/accounting/analytic-accounts/{analytic_account_id}/multi-analytic-plans/{analytic_plan}","title":"Get analytic account (Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/get-analytic-account-multiple-analytic-plans"},{"openapi":"patch /consumers/{consumer_id}/accounting/analytic-accounts/{analytic_account_id}/multi-analytic-plans/{analytic_plan}","title":"Update analytic account (Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/update-analytic-account-multiple-analytic-plans"},{"openapi":"get /consumers/{consumer_id}/accounting/analytic-accounts/multi-analytic-plans","title":"Get analytic accounts (Multiple Analytic Plans)","href":"/api-reference/endpoints/accounting/get-analytic-accounts-multiple-analytic-plans"}]},{"group":"Outstandings","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/outstandings","title":"Get clients/suppliers outstanding items","href":"/api-reference/endpoints/accounting/get-clientssuppliers-outstanding-items"}]},{"group":"VAT codes","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/vat-codes","title":"Get vat codes","href":"/api-reference/endpoints/accounting/get-vat-codes"}]},{"group":"Attachments","pages":[{"openapi":"post /consumers/{consumer_id}/accounting/invoices/pdf/{invoice_id}","title":"Attach a document (PDF)","href":"/api-reference/endpoints/accounting/attach-a-document-pdf"},{"openapi":"get /consumers/{consumer_id}/accounting/attachments","title":"Get attachments","href":"/api-reference/endpoints/accounting/get-attachments"}]},{"group":"Exports","pages":[{"openapi":"get /consumers/{consumer_id}/accounting/export-fec","title":"Export entries in FEC format","href":"/api-reference/endpoints/accounting/export-entries-in-fec-format"}]}]},{"group":"Invoicing","pages":[{"group":"Contacts","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/contacts/{contact_id}","title":"Retrieve one contact","href":"/api-reference/endpoints/invoicing/retrieve-one-contact"},{"openapi":"get /consumers/{consumer_id}/invoicing/contacts","title":"Retrieve all contacts","href":"/api-reference/endpoints/invoicing/retrieve-all-contacts"},{"openapi":"post /consumers/{consumer_id}/invoicing/contacts","title":"Create a contact","href":"/api-reference/endpoints/invoicing/create-a-contact"}]},{"group":"Invoices","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/invoices/{invoice_id}","title":"Retrieve one invoice","href":"/api-reference/endpoints/invoicing/retrieve-one-invoice"},{"openapi":"get /consumers/{consumer_id}/invoicing/invoices","title":"Retrieve all invoices","href":"/api-reference/endpoints/invoicing/retrieve-all-invoices"},{"openapi":"post /consumers/{consumer_id}/invoicing/invoices","title":"Create an invoice","href":"/api-reference/endpoints/invoicing/create-an-invoice"},{"openapi":"post /consumers/{consumer_id}/invoicing/upload-document","title":"Upload a document (PDF)","href":"/api-reference/endpoints/invoicing/upload-a-document-pdf"}]},{"group":"Products","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/products/{product_id}","title":"Retrieve one product","href":"/api-reference/endpoints/invoicing/retrieve-one-product"},{"openapi":"get /consumers/{consumer_id}/invoicing/products","title":"Retrieve all products","href":"/api-reference/endpoints/invoicing/retrieve-all-products"},{"openapi":"post /consumers/{consumer_id}/invoicing/products","title":"Create a product","href":"/api-reference/endpoints/invoicing/create-a-product"}]},{"group":"Taxes","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/taxes/{tax_id}","title":"Retrieve one tax","href":"/api-reference/endpoints/invoicing/retrieve-one-tax"},{"openapi":"get /consumers/{consumer_id}/invoicing/taxes","title":"Retrieve all taxes","href":"/api-reference/endpoints/invoicing/retrieve-all-taxes"}]},{"group":"Opportunities","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/opportunities/{opportunity_id}","title":"Retrieve one opportunity","href":"/api-reference/endpoints/invoicing/retrieve-one-opportunity"},{"openapi":"get /consumers/{consumer_id}/invoicing/opportunities","title":"Retrieve all opportunities","href":"/api-reference/endpoints/invoicing/retrieve-all-opportunities"}]},{"group":"Payments","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/payments","title":"Retrieve all payments (invoicing)","href":"/api-reference/endpoints/invoicing/retrieve-all-payments-invoicing"}]},{"group":"Payment methods","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/payment-methods","title":"Retrieve all payment methods","href":"/api-reference/endpoints/invoicing/retrieve-all-payment-methods"}]},{"group":"Bank Accounts","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/bank-accounts","title":"Retrieve all Bank Accounts","href":"/api-reference/endpoints/invoicing/retrieve-all-bank-accounts"}]},{"group":"Bank Transactions","pages":[{"openapi":"get /consumers/{consumer_id}/invoicing/bank-transactions","title":"Retrieve all Bank Transactions","href":"/api-reference/endpoints/invoicing/retrieve-all-bank-transactions"}]}]},{"group":"POS","pages":[{"group":"Orders","pages":[{"openapi":"get /consumers/{consumer_id}/pos/orders","title":"Get orders","href":"/api-reference/endpoints/point-of-sale/get-orders"},{"openapi":"get /consumers/{consumer_id}/pos/orders/{order_id}","title":"Get one order","href":"/api-reference/endpoints/point-of-sale/get-one-order"},{"openapi":"get /consumers/{consumer_id}/pos/sales","title":"Get sales","href":"/api-reference/endpoints/point-of-sale/get-sales"},{"openapi":"patch /consumers/{consumer_id}/pos/orders/{order_id}","title":"Update order","href":"/api-reference/endpoints/point-of-sale/update-order"}]},{"group":"Payment methods","pages":[{"openapi":"get /consumers/{consumer_id}/pos/payment-methods","title":"Get payment methods (POS)","href":"/api-reference/endpoints/point-of-sale/get-payment-methods-pos"}]},{"group":"Payments","pages":[{"openapi":"get /consumers/{consumer_id}/pos/payments","title":"Get payments","href":"/api-reference/endpoints/point-of-sale/get-payments"}]},{"group":"Closure / Report","pages":[{"openapi":"get /consumers/{consumer_id}/pos/closures/{date}","title":"Get closure info for a specific day","href":"/api-reference/endpoints/point-of-sale/get-closure-info-for-a-specific-day"},{"openapi":"get /consumers/{consumer_id}/pos/report","title":"Get report for a specific date (E-reporting)","href":"/api-reference/endpoints/point-of-sale/get-report-for-a-specific-date-e-reporting"}]},{"group":"Locations","pages":[{"openapi":"get /consumers/{consumer_id}/pos/locations","title":"Get locations","href":"/api-reference/endpoints/point-of-sale/get-locations"}]},{"group":"Products","pages":[{"openapi":"get /consumers/{consumer_id}/pos/products","title":"Get products","href":"/api-reference/endpoints/point-of-sale/get-products"},{"openapi":"get /consumers/{consumer_id}/pos/modifiers","title":"Get Modifiers","href":"/api-reference/endpoints/point-of-sale/get-modifiers"}]},{"group":"Categories","pages":[{"openapi":"get /consumers/{consumer_id}/pos/product-categories","title":"Get product categories","href":"/api-reference/endpoints/point-of-sale/get-product-categories"},{"openapi":"get /consumers/{consumer_id}/pos/accounting-categories","title":"Get accounting categories","href":"/api-reference/endpoints/point-of-sale/get-accounting-categories"}]},{"group":"Customers","pages":[{"openapi":"get /consumers/{consumer_id}/pos/customers","title":"Get customers","href":"/api-reference/endpoints/point-of-sale/get-customers"},{"openapi":"get /consumers/{consumer_id}/pos/customers/{customer_id}","title":"Get one customer","href":"/api-reference/endpoints/point-of-sale/get-one-customer"},{"openapi":"post /consumers/{consumer_id}/pos/customers","title":"Create one customer","href":"/api-reference/endpoints/point-of-sale/create-one-customer"}]},{"group":"Objectives","pages":[{"openapi":"get /consumers/{consumer_id}/pos/objectives","title":"Get objectives","href":"/api-reference/endpoints/point-of-sale/get-objectives"}]},{"group":"Taxes","pages":[{"openapi":"get /consumers/{consumer_id}/pos/tax-rates","title":"Get tax rates (POS)","href":"/api-reference/endpoints/point-of-sale/get-tax-rates-pos"}]}]},{"group":"eCommerce","pages":[{"group":"Orders","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/orders","title":"Get all orders","href":"/api-reference/endpoints/ecommerce/get-all-orders"},{"openapi":"get /consumers/{consumer_id}/commerce/orders/{order_id}","title":"Get one specific order","href":"/api-reference/endpoints/ecommerce/get-one-specific-order"},{"openapi":"post /consumers/{consumer_id}/commerce/orders","title":"Create an order","href":"/api-reference/endpoints/ecommerce/create-an-order"}]},{"group":"Products \u0026 variants","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/products","title":"Get all products","href":"/api-reference/endpoints/ecommerce/get-all-products"},{"openapi":"get /consumers/{consumer_id}/commerce/products/{product_id}","title":"Get one specific product","href":"/api-reference/endpoints/ecommerce/get-one-specific-product"},{"openapi":"get /consumers/{consumer_id}/commerce/variants/{variant_id}","title":"Get one specific product variant","href":"/api-reference/endpoints/ecommerce/get-one-specific-product-variant"},{"openapi":"post /consumers/{consumer_id}/commerce/variants/set_quantity/{variant_id}","title":"Update available quantity","href":"/api-reference/endpoints/ecommerce/update-available-quantity"}]},{"group":"Categories","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/product-categories","title":"Get all product categories","href":"/api-reference/endpoints/ecommerce/get-all-product-categories"}]},{"group":"Customers","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/customers","title":"Get all customers","href":"/api-reference/endpoints/ecommerce/get-all-customers"},{"openapi":"get /consumers/{consumer_id}/commerce/customers/{customer_id}","title":"Get one specific customer","href":"/api-reference/endpoints/ecommerce/get-one-specific-customer"}]},{"group":"Payment methods","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/payment-methods","title":"Get all payment methods","href":"/api-reference/endpoints/ecommerce/get-all-payment-methods"}]},{"group":"Locations","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/locations","title":"Get all locations","href":"/api-reference/endpoints/ecommerce/get-all-locations"}]},{"group":"Countries","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/countries","title":"Get all countries","href":"/api-reference/endpoints/ecommerce/get-all-countries"}]},{"group":"Taxes","pages":[{"openapi":"get /consumers/{consumer_id}/commerce/taxes","title":"Get all tax rates","href":"/api-reference/endpoints/ecommerce/get-all-tax-rates"}]}]},{"group":"PMS","pages":[{"group":"Orders","pages":[{"openapi":"get /consumers/{consumer_id}/pms/orders","title":"Get orders (PMS)","href":"/api-reference/endpoints/property-management-system/get-orders-pms"}]},{"group":"Invoices","pages":[{"openapi":"get /consumers/{consumer_id}/pms/invoices","title":"Get invoices (PMS)","href":"/api-reference/endpoints/property-management-system/get-invoices-pms"}]},{"group":"Payment methods","pages":[{"openapi":"get /consumers/{consumer_id}/pms/payment-methods","title":"Get payment methods (PMS)","href":"/api-reference/endpoints/property-management-system/get-payment-methods-pms"}]},{"group":"Payments","pages":[{"openapi":"get /consumers/{consumer_id}/pms/payments","title":"Get payments (PMS)","href":"/api-reference/endpoints/property-management-system/get-payments-pms"}]},{"group":"Closure info","pages":[{"openapi":"get /consumers/{consumer_id}/pms/closures/{date}","title":"Get closure info for a specific day (PMS)","href":"/api-reference/endpoints/property-management-system/get-closure-info-for-a-specific-day-pms"}]},{"group":"Locations","pages":[{"openapi":"get /consumers/{consumer_id}/pms/locations","title":"Get locations (PMS)","href":"/api-reference/endpoints/property-management-system/get-locations-pms"}]},{"group":"Categories","pages":[{"openapi":"get /consumers/{consumer_id}/pms/accounting-categories","title":"Get accounting categories (PMS)","href":"/api-reference/endpoints/property-management-system/get-accounting-categories-pms"}]},{"group":"Customers","pages":[{"openapi":"get /consumers/{consumer_id}/pms/customers","title":"Get customers (PMS)","href":"/api-reference/endpoints/property-management-system/get-customers-pms"}]},{"group":"Taxes","pages":[{"openapi":"get /consumers/{consumer_id}/pms/taxes","title":"Get tax rates (PMS)","href":"/api-reference/endpoints/property-management-system/get-tax-rates-pms"}]},{"group":"Accounting transactions","pages":[{"openapi":"get /consumers/{consumer_id}/pms/accounting-transactions","title":"Get the accounting transactions (PMS)","href":"/api-reference/endpoints/property-management-system/get-the-accounting-transactions-pms"}]}]},{"group":"Payment","pages":[{"group":"Payments","pages":[{"openapi":"get /consumers/{consumer_id}/payment/payments/{payment_id}","title":"Get a payment","href":"/api-reference/endpoints/payment/get-a-payment"},{"openapi":"get /consumers/{consumer_id}/payment/payments","title":"Retrieve all payments","href":"/api-reference/endpoints/payment/retrieve-all-payments"}]},{"group":"Balances","pages":[{"openapi":"get /consumers/{consumer_id}/payment/balances","title":"Retrieve all balances","href":"/api-reference/endpoints/payment/retrieve-all-balances"}]},{"group":"Transactions","pages":[{"openapi":"get /consumers/{consumer_id}/payment/transactions","title":"Retrieve all transactions","href":"/api-reference/endpoints/payment/retrieve-all-transactions"}]},{"group":"Refunds","pages":[{"openapi":"get /consumers/{consumer_id}/payment/refunds","title":"Retrieve all refunds","href":"/api-reference/endpoints/payment/retrieve-all-refunds"}]}]},{"group":"Banking","pages":[{"group":"Financial institutions","pages":[{"openapi":"get /consumers/{consumer_id}/banking/financial-institutions","title":"Get list of financial institutions","href":"/api-reference/endpoints/banking/get-list-of-financial-institutions"}]},{"group":"Banking accounts","pages":[{"openapi":"get /consumers/{consumer_id}/banking/accounts","title":"Get list of banking accounts","href":"/api-reference/endpoints/banking/get-list-of-banking-accounts"},{"openapi":"get /consumers/{consumer_id}/banking/counterparts","title":"Get aggregated list of account counterparts found in transactions","href":"/api-reference/endpoints/banking/get-aggregated-list-of-account-counterparts-found-in-transactions"}]},{"group":"Transactions","pages":[{"openapi":"get /consumers/{consumer_id}/banking/transactions","title":"Get list of financial transactions","href":"/api-reference/endpoints/banking/get-list-of-financial-transactions"}]}]},{"group":"Spend Management","pages":[{"group":"Legal entities","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/legal-entities","title":"Retrieve legal entities available to this connection","href":"/api-reference/endpoints/spend-management/retrieve-legal-entities-available-to-this-connection"}]},{"group":"Ledger accounts","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/ledger-accounts","title":"Retrieve the chart of accounts","href":"/api-reference/endpoints/spend-management/retrieve-the-chart-of-accounts"},{"openapi":"post /consumers/{consumer_id}/spend_management/ledger-accounts","title":"Create ledger account","href":"/api-reference/endpoints/spend-management/create-ledger-account"},{"openapi":"patch /consumers/{consumer_id}/spend_management/ledger-accounts/{ledger_account_id}","title":"Update ledger account","href":"/api-reference/endpoints/spend-management/update-ledger-account"}]},{"group":"Tax codes","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/tax-codes","title":"Retrieve all tax codes","href":"/api-reference/endpoints/spend-management/retrieve-all-tax-codes"},{"openapi":"post /consumers/{consumer_id}/spend_management/tax-codes","title":"Create tax code","href":"/api-reference/endpoints/spend-management/create-tax-code"},{"openapi":"patch /consumers/{consumer_id}/spend_management/tax-codes/{tax_code_id}","title":"Update tax code","href":"/api-reference/endpoints/spend-management/update-tax-code"}]},{"group":"Analytical plans","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/analytical-plans","title":"Retrieve all analytical plans (cost centers, projects, ...)","href":"/api-reference/endpoints/spend-management/retrieve-all-analytical-plans-cost-centers-projects-"},{"openapi":"post /consumers/{consumer_id}/spend_management/analytical-plans","title":"Create an analytical plan","href":"/api-reference/endpoints/spend-management/create-an-analytical-plan"},{"openapi":"patch /consumers/{consumer_id}/spend_management/analytical-plans/{analytical_plan_id}","title":"Update an analytical plan","href":"/api-reference/endpoints/spend-management/update-an-analytical-plan"}]},{"group":"Analytic accounts","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/analytic-accounts","title":"Retrieve the values of the analytical plans","href":"/api-reference/endpoints/spend-management/retrieve-the-values-of-the-analytical-plans"},{"openapi":"get /consumers/{consumer_id}/spend_management/analytic-accounts/{analytic_account_id}/analytic-plans/{analytic_plan}","title":"Get one analytic account","href":"/api-reference/endpoints/spend-management/get-one-analytic-account"},{"openapi":"post /consumers/{consumer_id}/spend_management/analytic-accounts/analytic-plans/{analytic_plan}","title":"Create analytic account","href":"/api-reference/endpoints/spend-management/create-analytic-account"},{"openapi":"patch /consumers/{consumer_id}/spend_management/analytic-accounts/{analytic_account_id}/analytic-plans/{analytic_plan}","title":"Update analytic account","href":"/api-reference/endpoints/spend-management/update-analytic-account"}]},{"group":"Payables","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/payables","title":"Retrieve payables (supplier invoices, supplier refunds, or card purchases)","href":"/api-reference/endpoints/spend-management/retrieve-payables-supplier-invoices-supplier-refunds-or-card-purchases"},{"openapi":"get /consumers/{consumer_id}/spend_management/payables/{payable_id}","title":"Get one payable","href":"/api-reference/endpoints/spend-management/get-one-payable"},{"openapi":"patch /consumers/{consumer_id}/spend_management/payables/{payable_id}/mark-as-exported","title":"Mark one payable as exported","href":"/api-reference/endpoints/spend-management/mark-one-payable-as-exported"}]},{"group":"Financial movements","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/financial-movements","title":"Retrieve all financial movements (payments, refunds, reimbursements, ...)","href":"/api-reference/endpoints/spend-management/retrieve-all-financial-movements-payments-refunds-reimbursements-"},{"openapi":"patch /consumers/{consumer_id}/spend_management/financial-movements/{financial_movement_id}/mark-as-exported","title":"Mark one financial movement as exported","href":"/api-reference/endpoints/spend-management/mark-one-financial-movement-as-exported"}]},{"group":"Suppliers","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/suppliers","title":"Retrieve all suppliers/vendors","href":"/api-reference/endpoints/spend-management/retrieve-all-suppliersvendors"},{"openapi":"get /consumers/{consumer_id}/spend_management/suppliers/{supplier_id}","title":"Get one supplier/vendor","href":"/api-reference/endpoints/spend-management/get-one-suppliervendor"},{"openapi":"post /consumers/{consumer_id}/spend_management/suppliers","title":"Create supplier/vendor","href":"/api-reference/endpoints/spend-management/create-suppliervendor"},{"openapi":"patch /consumers/{consumer_id}/spend_management/suppliers/{supplier_id}","title":"Update supplier/vendor","href":"/api-reference/endpoints/spend-management/update-suppliervendor"}]},{"group":"Employees","pages":[{"openapi":"get /consumers/{consumer_id}/spend_management/employees","title":"Retrieve all employees","href":"/api-reference/endpoints/spend-management/retrieve-all-employees"}]}]},{"group":"Other","pages":[{"group":"API transactions","pages":[{"openapi":"get /consumers/{consumer_id}/connections/{connection_id}/transactions","title":"Get transaction information","href":"/api-reference/endpoints/connections/get-transaction-information"}]},{"group":"Webhooks","pages":[{"openapi":"post /webhooks","title":"Add new webhook instance","href":"/api-reference/endpoints/webhooks/add-new-webhook-instance"},{"openapi":"get /webhooks/{webhookid}","title":"Get one webhook instance","href":"/api-reference/endpoints/webhooks/get-one-webhook-instance"},{"openapi":"get /webhooks","title":"Get list of webhook instances","href":"/api-reference/endpoints/webhooks/get-list-of-webhook-instances"},{"openapi":"patch /webhooks/{webhookid}","title":"Update one webhook","href":"/api-reference/endpoints/webhooks/update-one-webhook"},{"openapi":"delete /webhooks/{webhookid}","title":"Delete one webhook","href":"/api-reference/endpoints/webhooks/delete-one-webhook"},{"openapi":"get /webhooks/list","title":"Get list of possible webhooks","href":"/api-reference/endpoints/webhooks/get-list-of-possible-webhooks"},{"openapi":"get /webhooks/{webhookid}/logs","title":"Get list of webhook logs for one webhook","href":"/api-reference/endpoints/webhooks/get-list-of-webhook-logs-for-one-webhook"}]},{"group":"Syncs","pages":[{"openapi":"get /syncs","title":"Get syncs","href":"/api-reference/endpoints/syncs/get-syncs"},{"openapi":"get /syncs/{syncid}","title":"Get sync","href":"/api-reference/endpoints/syncs/get-sync"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}","title":"Get sync information for one consumer","href":"/api-reference/endpoints/consumers/get-sync-information-for-one-consumer"},{"openapi":"post /consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/enable","title":"Enable a flow for a specific consumer","href":"/api-reference/endpoints/syncs/enable-a-flow-for-a-specific-consumer"},{"openapi":"post /syncs/{syncid}/flows/{flowid}/event","deprecated":true,"title":"Send a custom event for a specific flow (deprecated)","href":"/api-reference/endpoints/syncs/send-a-custom-event-for-a-specific-flow-deprecated"},{"openapi":"get /syncs/{syncid}/flows/{flowid}/executions/{executionid}","title":"Get execution details","href":"/api-reference/endpoints/syncs/get-execution-details"},{"openapi":"get /consumers/{consumer_id}/datastore/{datastoreid}/data","title":"Get execution data for a specific consumer and a specific datastore","href":"/api-reference/endpoints/consumers/get-execution-data-for-a-specific-consumer-and-a-specific-datastore"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}/executions","title":"Get executions information for one consumer/flow/sync","href":"/api-reference/endpoints/consumers/get-executions-information-for-one-consumerflowsync"},{"openapi":"get /syncs/{syncid}/executions","title":"Get executions for a sync","href":"/api-reference/endpoints/syncs/get-executions-for-a-sync"},{"openapi":"patch /consumers/{consumer_id}/syncs/{syncid}","title":"Update flow mappings for a specific consumer","href":"/api-reference/endpoints/syncs/update-flow-mappings-for-a-specific-consumer"},{"openapi":"patch /consumers/{consumer_id}/syncs/{syncid}/flows/{flowid}","title":"Update flow settings for a specific consumer","href":"/api-reference/endpoints/syncs/update-flow-settings-for-a-specific-consumer"},{"openapi":"post /consumers/{consumer_id}/syncs","title":"Retrieve the url of a sync for a specific consumer","href":"/api-reference/endpoints/consumers/retrieve-the-url-of-a-sync-for-a-specific-consumer"}]},{"group":"Agentic syncs","pages":[{"openapi":"get /syncs/{syncid}/capabilities","title":"Capabilities of an agentic sync, and which your consumers are offered","href":"/api-reference/endpoints/syncs/capabilities-of-an-agentic-sync-and-which-your-consumers-are-offered"},{"openapi":"put /syncs/{syncid}/capabilities","title":"Choose which capabilities your consumers are offered","href":"/api-reference/endpoints/syncs/choose-which-capabilities-your-consumers-are-offered"},{"openapi":"get /syncs/{syncid}/integrations","title":"Integrations a consumer can connect to an agentic sync","href":"/api-reference/endpoints/syncs/integrations-a-consumer-can-connect-to-an-agentic-sync"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/capabilities","title":"A consumer's setup of an agentic sync","href":"/api-reference/endpoints/syncs/a-consumers-setup-of-an-agentic-sync"},{"openapi":"put /consumers/{consumer_id}/syncs/{syncid}/capabilities","title":"Choose a consumer's capabilities and modes","href":"/api-reference/endpoints/syncs/choose-a-consumers-capabilities-and-modes"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/journey","title":"Where a consumer stands in setting up an agentic sync","href":"/api-reference/endpoints/syncs/where-a-consumer-stands-in-setting-up-an-agentic-sync"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/questions","title":"Questions a consumer's capabilities ask, with their answers","href":"/api-reference/endpoints/syncs/questions-a-consumers-capabilities-ask-with-their-answers"},{"openapi":"patch /consumers/{consumer_id}/syncs/{syncid}/questions","title":"Answer a consumer's questions","href":"/api-reference/endpoints/syncs/answer-a-consumers-questions"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/mappings","title":"The mapping tables a consumer's sync needs","href":"/api-reference/endpoints/syncs/the-mapping-tables-a-consumers-sync-needs"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/mappings/{table_key}","title":"One mapping table of a consumer: its rows, values and candidates","href":"/api-reference/endpoints/syncs/one-mapping-table-of-a-consumer:-its-rows-values-and-candidates"},{"openapi":"post /consumers/{consumer_id}/syncs/{syncid}/ai-fill","title":"Fill a consumer's mapping values","href":"/api-reference/endpoints/syncs/fill-a-consumers-mapping-values"},{"openapi":"post /consumers/{consumer_id}/syncs/{syncid}/previews","title":"Preview what a consumer's sync would create","href":"/api-reference/endpoints/syncs/preview-what-a-consumers-sync-would-create"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/previews","title":"A consumer's recent previews","href":"/api-reference/endpoints/syncs/a-consumers-recent-previews"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}","title":"One preview: where it stands, what it would create and what would fail","href":"/api-reference/endpoints/syncs/one-preview:-where-it-stands-what-it-would-create-and-what-would-fail"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}/objects","title":"The objects a preview would create","href":"/api-reference/endpoints/syncs/the-objects-a-preview-would-create"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/objects/{kind}","title":"The objects of one type a consumer's sync handled","href":"/api-reference/endpoints/syncs/the-objects-of-one-type-a-consumers-sync-handled"},{"openapi":"get /consumers/{consumer_id}/syncs/{syncid}/objects/{kind}/{object_id}","title":"What a consumer's sync did to one object","href":"/api-reference/endpoints/syncs/what-a-consumers-sync-did-to-one-object"}]},{"group":"Data layer","pages":[{"openapi":"post /consumers/{consumer_id}/connections/{connection_id}/enable_datalayer","title":"Enable the datalayer sync for a connection","href":"/api-reference/endpoints/datalayer/enable-the-datalayer-sync-for-a-connection"},{"openapi":"post /consumers/{consumer_id}/connections/{connection_id}/refresh_datalayer","title":"Refresh the datalayer sync for a connection","href":"/api-reference/endpoints/datalayer/refresh-the-datalayer-sync-for-a-connection"},{"openapi":"post /consumers/{consumer_id}/connections/{connection_id}/disable_datalayer","title":"Disable the datalayer sync for a connection","href":"/api-reference/endpoints/datalayer/disable-the-datalayer-sync-for-a-connection"}]},{"group":"Issues","pages":[{"openapi":"get /issues","title":"Get issues","href":"/api-reference/endpoints/issues/get-issues"},{"openapi":"get /consumers/{consumer_id}/issues","title":"Get issues by consumer id","href":"/api-reference/endpoints/issues/get-issues-by-consumer-id"},{"openapi":"get /issues/{issue_id}","title":"Get details about one issue","href":"/api-reference/endpoints/issues/get-details-about-one-issue"}]},{"group":"Datastores","pages":[{"openapi":"get /datastores","title":"Get list of datastores","href":"/api-reference/endpoints/datastores/get-list-of-datastores"}]}]}]},{"tab":"Use Cases","pages":[{"title":"Use Cases","href":"/use-cases/overview"}]},{"tab":"Connectors","pages":[{"title":"Connectors","href":"/connectors/connectors"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/platform/overview"}]},{"tab":"AI","pages":[{"title":"AI","href":"/ai/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelogs/2026-07"}]}]},{"dropdown":"User Documentation","icon":"circle-question","groups":[{"group":"Overview","pages":[{"title":"Help Center","href":"/help/overview"}]},{"group":"Accounting","pages":[{"title":"a3ERP","sidebarTitle":"a3ERP","href":"/help/connectors/8039"},{"title":"ACD","sidebarTitle":"ACD","href":"/help/connectors/8003"},{"title":"ACD: launch an analysis","sidebarTitle":"ACD: Launch an analysis","href":"/help/connectors/8003/launch-an-analysis"},{"title":"AFAS","sidebarTitle":"AFAS Software","href":"/help/connectors/8037"},{"title":"Cegid Loop","sidebarTitle":"Cegid Loop","href":"/help/connectors/8011"},{"title":"Contasol","sidebarTitle":"Contasol","href":"/help/connectors/8049"},{"title":"DATEV","sidebarTitle":"DATEV","href":"/help/connectors/8019"},{"title":"DATEV Buchungsdatenservice","sidebarTitle":"DATEV - Buchungsdatenservice","href":"/help/connectors/8046"},{"title":"DATEV (LocalAgent)","sidebarTitle":"DATEV - Local Agent","href":"/help/connectors/8041"},{"title":"Dinero","sidebarTitle":"Dinero","href":"/help/connectors/8050"},{"title":"Dynamics 365 Business Central","sidebarTitle":"Dynamics 365 Business Central","href":"/help/connectors/8012"},{"title":"e-Boekhouden","sidebarTitle":"e-Boekhouden","href":"/help/connectors/8025"},{"title":"Visma e-conomic","sidebarTitle":"Visma e-conomic","href":"/help/connectors/8047"},{"title":"Exact Online BE","sidebarTitle":"Exact Online BE","href":"/help/connectors/8000"},{"title":"Exact Online DE","sidebarTitle":"Exact Online DE","href":"/help/connectors/8030"},{"title":"Exact Online FR","sidebarTitle":"Exact Online FR","href":"/help/connectors/8014"},{"title":"Exact Online NL","sidebarTitle":"Exact Online NL","href":"/help/connectors/8026"},{"title":"Fiken","sidebarTitle":"Fiken","href":"/help/connectors/8044"},{"title":"Fortnox","sidebarTitle":"Fortnox","href":"/help/connectors/8048"},{"title":"FreeAgent","sidebarTitle":"FreeAgent","href":"/help/connectors/8032"},{"title":"Fulll","sidebarTitle":"Fulll","href":"/help/connectors/8017"},{"title":"Holded","sidebarTitle":"Holded","href":"/help/connectors/8033"},{"title":"Horus","sidebarTitle":"Horus","href":"/help/connectors/8001"},{"title":"InexWeb - In Extenso","sidebarTitle":"InexWeb - In Extenso","href":"/help/connectors/8022"},{"title":"Inqom","sidebarTitle":"Inqom","href":"/help/connectors/8016"},{"title":"Lexware Office (Lexoffice)","sidebarTitle":"Lexware Office (Lexoffice)","href":"/help/connectors/8038"},{"title":"Minox","sidebarTitle":"Minox","href":"/help/connectors/8010"},{"title":"Moneybird","sidebarTitle":"Moneybird","href":"/help/connectors/8040"},{"title":"MyUnisoft","sidebarTitle":"MyUnisoft","href":"/help/connectors/8006"},{"title":"NetSuite","sidebarTitle":"NetSuite","href":"/help/connectors/8018"},{"title":"Octopus","sidebarTitle":"Octopus","href":"/help/connectors/8007"},{"title":"Odoo","sidebarTitle":"Odoo (Accounting)","href":"/help/connectors/1000"},{"title":"Pennylane","sidebarTitle":"Pennylane","href":"/help/connectors/8008"},{"title":"Procountor","sidebarTitle":"Procountor","href":"/help/connectors/8051"},{"title":"QuickBooks Accounting","sidebarTitle":"QuickBooks (Accounting)","href":"/help/connectors/8034"},{"title":"Sage 100 FR","sidebarTitle":"Sage 100 FR","href":"/help/connectors/8005"},{"title":"Sage 200 ES","sidebarTitle":"Sage 200 ES","href":"/help/connectors/8043"},{"title":"Sage 50 FR","sidebarTitle":"Sage 50 FR","href":"/help/connectors/8009"},{"title":"Sage 50 UK","sidebarTitle":"Sage 50 UK","href":"/help/connectors/8013"},{"title":"Sage BOB 50","sidebarTitle":"Sage BOB 50","href":"/help/connectors/1006"},{"title":"Sage Génération Experts","sidebarTitle":"Sage Génération Experts","href":"/help/connectors/8015"},{"title":"Sage Intacct","sidebarTitle":"Sage Intacct","href":"/help/connectors/8035"},{"title":"sevDesk","sidebarTitle":"sevDesk","href":"/help/connectors/8042"},{"title":"SnelStart","sidebarTitle":"SnelStart","href":"/help/connectors/8024"},{"title":"Tiime","sidebarTitle":"Tiime","href":"/help/connectors/8021"},{"title":"Tripletex","sidebarTitle":"Tripletex","href":"/help/connectors/8027"},{"title":"Twinfield","sidebarTitle":"Twinfield","href":"/help/connectors/8028"},{"title":"Visma eAccounting","sidebarTitle":"Visma eAccounting","href":"/help/connectors/8020"},{"title":"Visma Spiris","sidebarTitle":"Visma Spiris","href":"/help/connectors/8045"},{"title":"Winbooks Classic - Installation Guide","sidebarTitle":"Winbooks Classic - Local agent Installation Process","href":"/help/connectors/1005/installation-guide"},{"title":"Xero","sidebarTitle":"Xero","href":"/help/connectors/8029"},{"title":"Yuki","sidebarTitle":"Yuki","href":"/help/connectors/8023"}]},{"group":"POS","pages":[{"title":"Abill","href":"/help/connectors/9022"},{"title":"Addictill","href":"/help/connectors/9017"},{"title":"Agora","href":"/help/connectors/9042"},{"title":"APITIC","sidebarTitle":"Apitic","href":"/help/connectors/9024"},{"title":"Atilla","sidebarTitle":"AtillaSoft","href":"/help/connectors/9032"},{"title":"BDP","href":"/help/connectors/9028"},{"title":"Carrepos","href":"/help/connectors/9029"},{"title":"Cashmag","href":"/help/connectors/9015"},{"title":"Cashpad","href":"/help/connectors/9005"},{"title":"Cegid Retail","href":"/help/connectors/9031"},{"title":"Clyo Systems","href":"/help/connectors/9010"},{"title":"Clyo Systems - Prerequisite","href":"/help/connectors/9010/prerequisite"},{"title":"Connectill","href":"/help/connectors/9016"},{"title":"Fülle","href":"/help/connectors/9007"},{"title":"Fastmag","href":"/help/connectors/9040"},{"title":"HelloCash","href":"/help/connectors/9003"},{"title":"Hiboutik","href":"/help/connectors/9001"},{"title":"Hosteltactil","href":"/help/connectors/9041"},{"title":"Innovorder","href":"/help/connectors/9006"},{"title":"Jalia - JDC","href":"/help/connectors/9013"},{"title":"L'Addition","href":"/help/connectors/9019"},{"title":"Last.app","href":"/help/connectors/9021"},{"title":"Leo2","href":"/help/connectors/9025"},{"title":"Lightspeed","sidebarTitle":"Lightspeed (POS)","href":"/help/connectors/9008"},{"title":"MplusKASSA","href":"/help/connectors/9038"},{"title":"myPOS","sidebarTitle":"myPOS","href":"/help/connectors/9036"},{"title":"Neo","href":"/help/connectors/9050"},{"title":"Numier","href":"/help/connectors/9044"},{"title":"Odoo POS","sidebarTitle":"Odoo (POS)","href":"/help/connectors/9023"},{"title":"Oracle Simphony","href":"/help/connectors/9034"},{"title":"PI Electronique (Alpha Caisse)","href":"/help/connectors/9039"},{"title":"Planity","href":"/help/connectors/9018"},{"title":"Popina","href":"/help/connectors/9011"},{"title":"Izipass","href":"/help/connectors/9049"},{"title":"Restomax","href":"/help/connectors/9026"},{"title":"Revo","href":"/help/connectors/9037"},{"title":"Shopcaisse","href":"/help/connectors/9030"},{"title":"Shopify (POS)","href":"/help/connectors/9043"},{"title":"Square","sidebarTitle":"Square (POS)","href":"/help/connectors/9000"},{"title":"Synapsy","href":"/help/connectors/9004"},{"title":"Tactilpad","href":"/help/connectors/9027"},{"title":"Tiller","href":"/help/connectors/9020"},{"title":"Trivec","href":"/help/connectors/9009"},{"title":"Zelty","href":"/help/connectors/9012"},{"title":"Zettle","sidebarTitle":"PayPal POS (Zettle)","href":"/help/connectors/9002"}]},{"group":"Invoicing","pages":[{"title":"Axonaut","href":"/help/connectors/7000"},{"title":"Billit","href":"/help/connectors/7023"},{"title":"BoondManager","href":"/help/connectors/7009"},{"title":"Chargebee","href":"/help/connectors/7005"},{"title":"Digiforma","href":"/help/connectors/7027"},{"title":"Dolibarr","href":"/help/connectors/7022"},{"title":"EBP Gestion Commerciale","sidebarTitle":"EBP (Invoicing)","href":"/help/connectors/7026"},{"title":"Evoliz","href":"/help/connectors/7010"},{"title":"Factomos","href":"/help/connectors/7017"},{"title":"Fatture In Cloud","href":"/help/connectors/7016"},{"title":"Fuga","href":"/help/connectors/7021"},{"title":"Harvest","href":"/help/connectors/7008"},{"title":"Hubspot","sidebarTitle":"HubSpot","href":"/help/connectors/7014"},{"title":"Hyperline","href":"/help/connectors/7025"},{"title":"Odoo Invoicing","sidebarTitle":"Odoo (Invoicing)","href":"/help/connectors/7001"},{"title":"Organilog","href":"/help/connectors/7019"},{"title":"PayPal","sidebarTitle":"Paypal (Invoicing)","href":"/help/connectors/7013"},{"title":"Qonto","href":"/help/connectors/7015"},{"title":"Quickbooks","sidebarTitle":"QuickBooks (Invoicing)","href":"/help/connectors/7012"},{"title":"Sage 100 FR Gestion Commerciale - On premise","sidebarTitle":"Sage 100 Gestion Commerciale - On premise","href":"/help/connectors/7018/on-premise"},{"title":"Sage 100 FR Gestion Commerciale - SPC","sidebarTitle":"Sage 100 Gestion Commerciale - Azure Sage Partner Cloud (SPC)","href":"/help/connectors/7018/spc"},{"title":"Sage 100 Gestion Commerciale","href":"/help/connectors/7018"},{"title":"Sellsy","href":"/help/connectors/7003"},{"title":"TeamLeader","href":"/help/connectors/7002"},{"title":"Vosfactures","sidebarTitle":"Vos Factures","href":"/help/connectors/7006"},{"title":"Zoho Invoice","sidebarTitle":"Zoho One (Invoice)","href":"/help/connectors/7004"}]},{"group":"eCommerce","pages":[{"title":"Amazon Seller","href":"/help/connectors/6003"},{"title":"Prestashop","href":"/help/connectors/6002"},{"title":"Shopify","sidebarTitle":"Shopify (eCommerce)","href":"/help/connectors/1007"},{"title":"WooCommerce","href":"/help/connectors/1002"}]},{"group":"Payment","pages":[{"title":"AirWallex","href":"/help/connectors/7111"},{"title":"Gocardless","sidebarTitle":"GoCardless","href":"/help/connectors/7105"},{"title":"Shopify (Payment)","href":"/help/connectors/7110"},{"title":"Stripe","href":"/help/connectors/7103"},{"title":"SumUp","sidebarTitle":"SumUp (Payment)","href":"/help/connectors/7106"},{"title":"Klarna","sidebarTitle":"Klarna","href":"/help/connectors/7112"},{"title":"eBay","sidebarTitle":"eBay","href":"/help/connectors/7113"}]},{"group":"PMS","pages":[{"title":"Mews","href":"/help/connectors/9014"},{"title":"Noovy","href":"/help/connectors/9500"},{"title":"Oracle Opera","href":"/help/connectors/9502"},{"title":"Thais PMS","sidebarTitle":"Thaïs","href":"/help/connectors/9503"}]},{"group":"Banking","pages":[{"title":"Ponto","href":"/help/connectors/10000"}]},{"group":"Local Agent","pages":[{"title":"Local Agent","href":"/help/guides/local-agent"},{"title":"Cockpit — User Guide","href":"/help/guides/local-agent-cockpit-user-guide"},{"title":"Update the Local agent to the newest version","href":"/help/guides/update-the-local-agent-to-the-newest-version"},{"title":"Sage 100: Connect Multiple Accounting Folders at Once","href":"/help/guides/local-agent-connect-multiple-folders-at-once"}]},{"group":"Marketplace","pages":[{"title":"Marketplace","href":"/help/marketplace/overview"},{"title":"Marketplace Activation","href":"/help/marketplace/marketplace-activation"},{"group":"Manage my integrations","pages":[{"title":"Add a new integration","href":"/help/marketplace/manage-my-integrations/add-a-new-integration"},{"title":"Invite your accountant/client to configure the integration","href":"/help/marketplace/manage-my-integrations/invite-your-accountant-client-to-configure-the-integration"}]},{"group":"Manage my account","pages":[{"title":"Manage my profile","href":"/help/marketplace/manage-my-marketplace-account/manage-my-profile"},{"title":"Manage users \u0026 invitations","href":"/help/marketplace/manage-my-marketplace-account/manage-users-invitations"},{"title":"How to Update Account Access and Transfer Connection Ownership","href":"/help/marketplace/manage-my-marketplace-account/how-to-update-account-access-and-transfer-connection-ownership"},{"title":"Delete my account","href":"/help/marketplace/manage-my-marketplace-account/delete-my-account"}]}]},{"group":"Chift Insights","pages":[{"title":"Chift Insights","sidebarTitle":"Overview","href":"/insights/overview"}]}]}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/help/overview"}]},{"language":"es","pages":[{"title":"es","href":"/es/help/overview"}]},{"language":"nl","pages":[{"title":"nl","href":"/nl/help/overview"}]},{"language":"de","pages":[{"title":"de","href":"/de/help/overview"}]}]},"title":"Get connections - Chift","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}