{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Zenskar Documentation","colors":{"primary":"#0A1633","light":"#3B82F6","dark":"#1D3461"},"logo":{"light":"https://mintcdn.com/zenskar-3d451781/8zM5vHUy4GbBMWvZ/logo/for-light-themes.svg?fit=max\u0026auto=format\u0026n=8zM5vHUy4GbBMWvZ\u0026q=85\u0026s=7b3708e348af5e2ca4bd6f302186ccc2","dark":"https://mintcdn.com/zenskar-3d451781/8zM5vHUy4GbBMWvZ/logo/for-dark-themes.svg?fit=max\u0026auto=format\u0026n=8zM5vHUy4GbBMWvZ\u0026q=85\u0026s=591296922399ed1050dc1ee22842edbc"},"favicon":"https://mintcdn.com/zenskar-3d451781/8zM5vHUy4GbBMWvZ/favicon.svg?fit=max\u0026auto=format\u0026n=8zM5vHUy4GbBMWvZ\u0026q=85\u0026s=9a4afe8a43b76270c67c367963907132","navbar":{"links":[{"href":"mailto:help@zenskar.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.zenskar.com"}},"footer":{"socials":{"x":"https://x.com/zenskar","github":"https://github.com/zenskar","linkedin":"https://linkedin.com/company/zenskar"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.zenskar.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zenskar-3d451781","hasAudioNarration":false,"actualSubdomain":"zenskar-3d451781","customDomains":["zenskar.com"],"gitSource":{"type":"github","owner":"zenskar","repo":"documentation-public","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae30736bfc6b3f8ac65f926","collectionId":"4079bcdf-0019-4b48-88c5-394119dfc5b9","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae30736bfc6b3f8ac65f926"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae44f03a3eed560d7e476ac","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Documentation","count":322},{"language":"default","tag":"Product modules","count":191},{"language":"default","tag":"API Reference","count":164},{"language":"default","tag":"Third-party integrations","count":68},{"language":"default","tag":"How-to guides","count":43},{"language":"default","tag":"Contracts","count":40},{"language":"default","tag":"Data sources","count":39},{"language":"default","tag":"Concepts","count":36},{"language":"default","tag":"Accounting","count":35},{"language":"default","tag":"Settings","count":34}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@zenskar.com","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/data-sources/list-data-source-connectors","slug":"/api-reference/data-sources/list-data-source-connectors","pageMetadata":{"title":"List data-source connectors","description":"List datasource given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /datasources","href":"/api-reference/data-sources/list-data-source-connectors","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"List datasource given a \", _jsx(_components.code, {\n children: \"next\"\n }), \" or \", _jsx(_components.code, {\n children: \"previous\"\n }), \" cursor and a limit. If cursor is not provided you will get the beginning of the search set\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List data-source connectors","description":"List datasource given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /datasources","href":"/api-reference/data-sources/list-data-source-connectors","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Data Sources"],"summary":"List data-source connectors","description":"List datasource given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set","operationId":"List-data-source-connectors","parameters":["0902d5ec-6de3-4c0e-b0fc-3c625bf3e6fb","705f56d5-b1d3-467b-8e39-18f0f9cf145e","003d4f8a-8948-4550-bd99-1257526a5760","668cced2-7c3a-43d4-a66a-3b6e30eb8f39","19c03fac-57ed-44bf-b31c-6747bfec37e4","7f5845fc-9205-455e-9a8a-d57e1625c80c","c34aa98d-70fc-4ae3-bd34-6fcfdaed19c4","89fadbb0-fd87-4804-9c5c-f16368ae626d","e728e191-e1a2-49dc-af5d-d46cfdf2d006","993e7698-6dc6-4927-89b2-c8c812d93ae5","e176a5f2-d4f8-4487-b10a-9198a0bdf088","2a027d76-b944-4beb-8202-dc4d34312ca7","4101c567-1960-4b7c-832c-26de37c503bf","4e7f9fab-ec7d-482b-9aec-691271b2bbb1","d8ede97f-46af-42e5-8acb-d87cd9505ec2","2d42f7ed-1f3a-4cab-ac2d-eccbb651712d","5ad80ee0-9eff-4a43-9a03-c33cae40de93","19a0d309-1650-45e3-8578-0660627f8d80","b90055b1-ca9a-45dc-9ecc-15fd4e9c94bd","77144238-5991-41cf-9155-5caac6b50f2d","3489e139-fc25-494e-8458-8495d31b51e0","cc23abd7-1a22-4141-a939-6769f3f857a8","051f5c1a-7f5a-442e-acc5-e64866548290","950baa25-2882-4013-bc65-7ddd58a246fb","c8e58aa0-e3b2-4e21-9849-d93d283f10c4","34e43d6a-7edf-427f-af60-8cea859b4c47","cba0d9a7-1371-436c-8da6-5c379ddadb65","a925f19a-35e8-4de4-b5fc-01036bd1cda1","8142ad9a-c88e-4bdc-a37a-65ed11e36746","3410d240-66fb-42ff-be73-90cce3bd0066","3a6cc9db-87b4-4feb-8eb6-ea73cd5a61c6","98356fd1-2793-4346-b803-603d27668830","d45c7dd4-68fa-412d-b030-865d2bd6a5f8","2455e09a-5b99-406c-92f9-63d61d2dbb97","08a470d9-05c4-444a-b082-c3419503e8ff"],"responses":{"200":"28e82b02-2e66-4f95-93d9-07da89797c5b","422":"7b76a153-827b-40a2-aca6-edcdd0a8f677"},"method":"get","type":"path","servers":["b5800edb-bebb-41b7-ba92-5775ad182a17"],"security":["95049f99-a4b8-435b-a365-25b6391f1cff"],"path":"/datasources","baseUrlOptions":["https://api.zenskar.com"],"title":"List data-source connectors","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0902d5ec-6de3-4c0e-b0fc-3c625bf3e6fb":{"name":"cursor","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Cursor","description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","example":"V2VsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Cursor","description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response","example":"V2VsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response"},"705f56d5-b1d3-467b-8e39-18f0f9cf145e":{"name":"limit","in":"query","required":false,"schema":{"oneOf":[{"type":"integer","title":"Limit","description":"The number of results to return - defaults to 10","example":10,"uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","title":"Limit","description":"The number of results to return - defaults to 10","example":10,"uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"},"description":"The number of results to return - defaults to 10"},"003d4f8a-8948-4550-bd99-1257526a5760":{"name":"order","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Order","example":"order=created_at","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Order","example":"order=created_at","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"668cced2-7c3a-43d4-a66a-3b6e30eb8f39":{"name":"sort_key","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Sort Key","example":"sort_key=id","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Sort Key","example":"sort_key=id","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"19c03fac-57ed-44bf-b31c-6747bfec37e4":{"name":"sort_type","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Sort Type","example":"sort_key=asc","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Sort Type","example":"sort_key=asc","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"7f5845fc-9205-455e-9a8a-d57e1625c80c":{"name":"id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Id","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Id","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | null"}},"c34aa98d-70fc-4ae3-bd34-6fcfdaed19c4":{"name":"id__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Id In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Id In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"89fadbb0-fd87-4804-9c5c-f16368ae626d":{"name":"id__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Id Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Id Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"e728e191-e1a2-49dc-af5d-d46cfdf2d006":{"name":"name","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"993e7698-6dc6-4927-89b2-c8c812d93ae5":{"name":"name__ilike","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Name Ilike","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Name Ilike","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"e176a5f2-d4f8-4487-b10a-9198a0bdf088":{"name":"name__like","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Name Like","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Name Like","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"2a027d76-b944-4beb-8202-dc4d34312ca7":{"name":"name__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Name In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Name In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"4101c567-1960-4b7c-832c-26de37c503bf":{"name":"name__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Name Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Name Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"4e7f9fab-ec7d-482b-9aec-691271b2bbb1":{"name":"connector_type","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Connector Type","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Connector Type","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"d8ede97f-46af-42e5-8acb-d87cd9505ec2":{"name":"connector_type__ilike","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Connector Type Ilike","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Connector Type Ilike","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"2d42f7ed-1f3a-4cab-ac2d-eccbb651712d":{"name":"connector_type__like","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Connector Type Like","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Connector Type Like","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"5ad80ee0-9eff-4a43-9a03-c33cae40de93":{"name":"connector_type__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Connector Type In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Connector Type In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"19a0d309-1650-45e3-8578-0660627f8d80":{"name":"connector_type__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Connector Type Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Connector Type Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"b90055b1-ca9a-45dc-9ecc-15fd4e9c94bd":{"name":"destination","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Destination","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Destination","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"77144238-5991-41cf-9155-5caac6b50f2d":{"name":"destination__ilike","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Destination Ilike","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Destination Ilike","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"3489e139-fc25-494e-8458-8495d31b51e0":{"name":"destination__like","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Destination Like","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Destination Like","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"cc23abd7-1a22-4141-a939-6769f3f857a8":{"name":"destination__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Destination In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Destination In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"051f5c1a-7f5a-442e-acc5-e64866548290":{"name":"destination__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Destination Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Destination Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"950baa25-2882-4013-bc65-7ddd58a246fb":{"name":"status","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Status","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Status","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"c8e58aa0-e3b2-4e21-9849-d93d283f10c4":{"name":"status__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Status In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Status In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"34e43d6a-7edf-427f-af60-8cea859b4c47":{"name":"status__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Status Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Status Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"cba0d9a7-1371-436c-8da6-5c379ddadb65":{"name":"remote_conn","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Remote Conn","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Remote Conn","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"a925f19a-35e8-4de4-b5fc-01036bd1cda1":{"name":"created_at","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"8142ad9a-c88e-4bdc-a37a-65ed11e36746":{"name":"created_at__neq","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At Neq","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At Neq","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"3410d240-66fb-42ff-be73-90cce3bd0066":{"name":"created_at__gt","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At Gt","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At Gt","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"3a6cc9db-87b4-4feb-8eb6-ea73cd5a61c6":{"name":"created_at__gte","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At Gte","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At Gte","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"98356fd1-2793-4346-b803-603d27668830":{"name":"created_at__lt","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At Lt","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At Lt","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"d45c7dd4-68fa-412d-b030-865d2bd6a5f8":{"name":"created_at__lte","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At Lte","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Created At Lte","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"2455e09a-5b99-406c-92f9-63d61d2dbb97":{"name":"created_at__isnull","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Created At Isnull","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Created At Isnull","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"08a470d9-05c4-444a-b082-c3419503e8ff":{"name":"created_at__in","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Created At In","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Created At In","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"responses":{"28e82b02-2e66-4f95-93d9-07da89797c5b":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"results":{"items":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Data source Id","isRequired":true,"uniqueKey":"results.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","title":"Name","description":"name of the connector","isRequired":true,"uniqueKey":"results.items.[INDEX].name","typeLabel":"string"},"connector_type":{"type":"string","title":"Connector Type","description":"Connector type name","isRequired":true,"uniqueKey":"results.items.[INDEX].connector_type","typeLabel":"string"},"destination":{"type":"string","title":"Destination","description":"Data source destination","isRequired":true,"uniqueKey":"results.items.[INDEX].destination","typeLabel":"string"},"status":{"type":"string","enum":["active","disabled","processing","failed"],"title":"DataSourceStatusEnum","description":"Status of connector","isRequired":true,"uniqueKey":"results.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"remote_conn":{"type":"boolean","title":"Remote Conn","description":"Optional remote connection field","isRequired":true,"uniqueKey":"results.items.[INDEX].remote_conn","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","title":"Message","description":"Message of connector","uniqueKey":"results.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Message","description":"Message of connector","uniqueKey":"results.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].message","typeLabel":"string | null"}},"type":"object","required":["id","name","connector_type","destination","status","remote_conn"],"title":"DataSourceSchema","description":"Data source Response Schema","uniqueKey":"results.items.[INDEX]","typeLabel":"DataSourceSchema · object"},"type":"array","title":"Results","description":"The results for the current page","isRequired":true,"uniqueKey":"results","typeLabel":"DataSourceSchema · object[]"},"next":{"oneOf":[{"type":"string","title":"Next","description":"The cursor for the next page of results","example":"V2VsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"next.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next","description":"The cursor for the next page of results","example":"V2VsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"next.oneOf.1","typeLabel":"null"}],"uniqueKey":"next","typeLabel":"string | null"},"previous":{"oneOf":[{"type":"string","title":"Previous","description":"The cursor for the previous page of results","example":"GmBsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"previous.oneOf.0","typeLabel":"string"},{"type":"null","title":"Previous","description":"The cursor for the previous page of results","example":"GmBsbCBhcmV1IGN1cmlvdxM=","uniqueKey":"previous.oneOf.1","typeLabel":"null"}],"uniqueKey":"previous","typeLabel":"string | null"},"total_count":{"oneOf":[{"type":"integer","title":"Total Count","description":"The total count of rows","uniqueKey":"total_count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Total Count","description":"The total count of rows","uniqueKey":"total_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"total_count","typeLabel":"integer | null"}},"type":"object","required":["results"],"title":"PaginatedResults[DataSourceSchema]","uniqueKey":"","typeLabel":"PaginatedResults[DataSourceSchema] · object"},"examples":{"Example":{"title":"Example","value":{"results":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","connector_type":"\u003cstring>","destination":"\u003cstring>","status":"active","remote_conn":true,"message":"\u003cstring>"}],"next":"V2VsbCBhcmV1IGN1cmlvdxM=","previous":"GmBsbCBhcmV1IGN1cmlvdxM=","total_count":123}}},"exampleType":"generated"}},"exampleType":"generated"},"7b76a153-827b-40a2-aca6-edcdd0a8f677":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"95049f99-a4b8-435b-a365-25b6391f1cff":{"ApiTokenAuth":{"type":"apiKey","in":"header","name":"x-api-key","x-default":"\u003cyour-api-key>","scopes":[]},"OrganisationAuth":{"type":"apiKey","in":"header","name":"organisation","x-default":"\u003cyour-organisation-id>","scopes":[]}}},"servers":{"b5800edb-bebb-41b7-ba92-5775ad182a17":{"url":"https://api.zenskar.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","x-default":"\u003cyour-api-key>","scopes":[]},"schema":{"title":"x-api-key","type":"string","isRequired":true,"default":"\u003cyour-api-key>","typeLabel":"string","deprecated":false},"schemeName":"ApiTokenAuth","name":"x-api-key"},{"scheme":{"type":"apiKey","in":"header","name":"organisation","x-default":"\u003cyour-organisation-id>","scopes":[]},"schema":{"title":"organisation","type":"string","isRequired":true,"default":"\u003cyour-organisation-id>","typeLabel":"string","deprecated":false},"schemeName":"OrganisationAuth","name":"organisation"}],"title":"ApiTokenAuth \u0026 OrganisationAuth"}]},"originalFileLocation":"openAPI/openapi-20240301.json"},"subdomain":"zenskar-3d451781","siteName":"Zenskar Documentation","title":"List data-source connectors - Zenskar Documentation","contextualStarterQuestions":[{"_id":"6a1ea18b2a685f4ecf01ab55","deploymentId":"69e0a11c3e5ca76e4bd3f576","questionText":"How do I set pagination limits?","status":"active","generatedBy":"contextual","path":"api-reference/data-sources/list-data-source-connectors","createdAt":"2026-06-02T09:25:31.968Z","updatedAt":"2026-06-02T09:25:31.968Z","__v":0},{"_id":"6a1ea18b2a685f4ecf01ab54","deploymentId":"69e0a11c3e5ca76e4bd3f576","questionText":"What does the cursor parameter do?","status":"active","generatedBy":"contextual","path":"api-reference/data-sources/list-data-source-connectors","createdAt":"2026-06-02T09:25:31.968Z","updatedAt":"2026-06-02T09:25:31.968Z","__v":0},{"_id":"6a1ea18b2a685f4ecf01ab53","deploymentId":"69e0a11c3e5ca76e4bd3f576","questionText":"How do I list data sources?","status":"active","generatedBy":"contextual","path":"api-reference/data-sources/list-data-source-connectors","createdAt":"2026-06-02T09:25:31.968Z","updatedAt":"2026-06-02T09:25:31.968Z","__v":0}],"navMaps":{"firstHrefInVersion":{"cedar.ALPHA.20260301":{"href":"/api-reference/data-sources/list-data-source-connectors","matchLevel":0},"baobab.20240301":{"href":"/api-reference/data-sources/list-data-source-connectors","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-08-21T07:01:52.962Z","originalFileLocation":"api-reference/data-sources/list-data-source-connectors.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"List datasource given a next or previous cursor and a limit. If cursor is not provided you will get the beginning of the search set\">\u003cmeta data-mint-head name=\"application-name\" content=\"Zenskar Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_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=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List data-source connectors - Zenskar Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"List datasource given a next or previous cursor and a limit. If cursor is not provided you will get the beginning of the search set\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zenskar Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://zenskar.com/docs/api-reference/data-sources/list-data-source-connectors\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zenskar-3d451781.mintlify.app/_mintlify/api/og/v2?division=Data+Sources\u0026amp;title=List+data-source+connectors\u0026amp;description=List+datasource+given+a+%60next%60+or+%60previous%60+cursor+and+a+limit.+If+cursor+is+not+provided+you+will+get+the+beginning+of+the+search+set\u0026amp;theme=a962312433b97c96be242726\u0026amp;signature=14e5601f95190e7dce2a38510a453d2477819ddc5d7805a84e4e049091674b3f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List data-source connectors - Zenskar Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List datasource given a next or previous cursor and a limit. If cursor is not provided you will get the beginning of the search set\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zenskar-3d451781.mintlify.app/_mintlify/api/og/v2?division=Data+Sources\u0026amp;title=List+data-source+connectors\u0026amp;description=List+datasource+given+a+%60next%60+or+%60previous%60+cursor+and+a+limit.+If+cursor+is+not+provided+you+will+get+the+beginning+of+the+search+set\u0026amp;theme=a962312433b97c96be242726\u0026amp;signature=14e5601f95190e7dce2a38510a453d2477819ddc5d7805a84e4e049091674b3f\">\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=\"/docs/mintlify-assets/_mintlify/favicons/zenskar-3d451781/MYgNV77YbtdSqIUY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zenskar Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A1633\">\u003clink data-mint-head rel=\"canonical\" href=\"https://zenskar.com/docs/api-reference/data-sources/list-data-source-connectors\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/data-sources/list-data-source-connectors.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://zenskar.com/#organization\",\"name\":\"Zenskar Documentation\",\"url\":\"https://zenskar.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zenskar-3d451781/8zM5vHUy4GbBMWvZ/logo/for-light-themes.svg?fit=max\u0026auto=format\u0026n=8zM5vHUy4GbBMWvZ\u0026q=85\u0026s=7b3708e348af5e2ca4bd6f302186ccc2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://zenskar.com/docs#website\",\"name\":\"Zenskar Documentation\",\"url\":\"https://zenskar.com/docs\",\"publisher\":{\"@id\":\"https://zenskar.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://zenskar.com/docs/api-reference/data-sources/list-data-source-connectors#webpage\",\"url\":\"https://zenskar.com/docs/api-reference/data-sources/list-data-source-connectors\",\"name\":\"List data-source connectors\",\"description\":\"List datasource given a next or previous cursor and a limit. If cursor is not provided you will get the beginning of the search set\",\"dateModified\":\"2026-08-21T07:01:52.962Z\",\"isPartOf\":{\"@id\":\"https://zenskar.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://zenskar.com/docs/api-reference/data-sources/list-data-source-connectors#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://zenskar.com/docs/api-reference/data-sources/list-data-source-connectors#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Zenskar Documentation\",\"item\":\"https://zenskar.com/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List data-source connectors\",\"item\":\"https://zenskar.com/docs/api-reference/data-sources/list-data-source-connectors\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://zenskar.com/docs/api-reference/data-sources/list-data-source-connectors#apireference\",\"headline\":\"List data-source connectors\",\"name\":\"List data-source connectors\",\"description\":\"List datasource given a next or previous cursor and a limit. If cursor is not provided you will get the beginning of the search set\",\"url\":\"https://zenskar.com/docs/api-reference/data-sources/list-data-source-connectors\",\"mainEntityOfPage\":{\"@id\":\"https://zenskar.com/docs/api-reference/data-sources/list-data-source-connectors#webpage\"},\"dateModified\":\"2026-08-21T07:01:52.962Z\",\"publisher\":{\"@id\":\"https://zenskar.com/#organization\"},\"isPartOf\":{\"@id\":\"https://zenskar.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Zenskar Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Zenskar Documentation","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.zenskar.com/blog"}]},"versions":[{"version":"cedar.ALPHA.20260301","default":false,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/20260301/getting-started/introduction"}]},{"tab":"API Guides","pages":[{"title":"API Guides","href":"/20260301/api-guides/authentication"}]},{"tab":"API Reference","groups":[{"group":"Accounting","pages":[{"title":"Get chart of accounts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/chart_of_accounts","href":"/api-reference/accounting/get-chart-of-accounts"},{"title":"Get accounts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/accounts","href":"/api-reference/accounting/get-accounts"},{"title":"Create account","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/accounts","href":"/api-reference/accounting/create-account"},{"title":"Get close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/close_date","href":"/api-reference/accounting/get-close-date"},{"title":"Create close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/close_date","href":"/api-reference/accounting/create-close-date"},{"title":"Update close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /accounting_new/close_date","href":"/api-reference/accounting/update-close-date"},{"title":"Create journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/journal_entry","href":"/api-reference/accounting/create-journal-entry"},{"title":"Get journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_entry/{journal_entry_id}","href":"/api-reference/accounting/get-journal-entry"},{"title":"Update journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /accounting_new/journal_entry/{journal_entry_id}","href":"/api-reference/accounting/update-journal-entry"},{"title":"Get account balance by tag","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/accounts/{account_id}/balance","href":"/api-reference/accounting/get-account-balance-by-tag"},{"title":"Get journal entries","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_entries","href":"/api-reference/accounting/get-journal-entries"},{"title":"Get journal lines","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_lines","href":"/api-reference/accounting/get-journal-lines"},{"title":"Get balance sheet","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/balance_sheet/v2","href":"/api-reference/accounting/get-balance-sheet"},{"title":"Get income statement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/income_statement/v2","href":"/api-reference/accounting/get-income-statement"},{"title":"Validate period close","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/periods/validate-close","href":"/api-reference/accounting/validate-period-close"},{"title":"Close accounting period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/periods/close","href":"/api-reference/accounting/close-accounting-period"},{"title":"Get accounting periods","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods","href":"/api-reference/accounting/get-accounting-periods"},{"title":"Get last closed period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods/last","href":"/api-reference/accounting/get-last-closed-period"},{"title":"Get accounting period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods/{period_id}","href":"/api-reference/accounting/get-accounting-period"}]},{"group":"Billable Metrics","pages":[{"title":"List billable metrics","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates","href":"/api-reference/billable-metrics/list-billable-metrics"},{"title":"Create billable metric","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /aggregates","href":"/api-reference/billable-metrics/create-billable-metric"},{"title":"Get aggregate estimates for a period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates/estimates","href":"/api-reference/billable-metrics/get-aggregate-estimates-for-a-period"},{"title":"Get billable metric","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/get-billable-metric"},{"title":"Delete aggregate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/delete-aggregate"},{"title":"Update aggregate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/update-aggregate"}]},{"group":"Business Entities","pages":[{"title":"List business entities","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities","href":"/api-reference/business-entities/list-business-entities"},{"title":"Create business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /business_entities","href":"/api-reference/business-entities/create-business-entity"},{"title":"Get business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{entity_id}","href":"/api-reference/business-entities/get-business-entity"},{"title":"Update business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /business_entities/{entity_id}","href":"/api-reference/business-entities/update-business-entity"},{"title":"Get business entity config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{business_entity_id}/config","href":"/api-reference/business-entities/get-business-entity-config"},{"title":"Set business entity config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /business_entities/{business_entity_id}/config","href":"/api-reference/business-entities/set-business-entity-config"},{"title":"Get region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/get-region-config"},{"title":"Upsert region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/upsert-region-config"},{"title":"Delete region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/delete-region-config"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contacts","href":"/api-reference/contacts/create-contact"},{"title":"Get contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contacts/{contact_id}","href":"/api-reference/contacts/get-contact"},{"title":"Delete contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /contacts/{contact_id}","href":"/api-reference/contacts/delete-contact"},{"title":"Update contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contacts/{contact_id}","href":"/api-reference/contacts/update-contact"}]},{"group":"Contracts","pages":[{"title":"List contracts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2","href":"/api-reference/contracts/list-contracts"},{"title":"Create contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2","href":"/api-reference/contracts/create-contract"},{"title":"Get contract by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2/{contract_id}","href":"/api-reference/contracts/get-contract-by-id"},{"title":"Update contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /contract_v2/{contract_id}","href":"/api-reference/contracts/update-contract"},{"title":"Delete contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /contract_v2/{contract_id}","href":"/api-reference/contracts/delete-contract"},{"title":"Get contract amendments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2/{contract_id}/amendments","href":"/api-reference/contracts/get-contract-amendments"},{"title":"Create contract phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/phases","href":"/api-reference/contracts/create-contract-phase"},{"title":"Pause contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/pause","href":"/api-reference/contracts/pause-contract"},{"title":"Update pause contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/pause","href":"/api-reference/contracts/update-pause-contract"},{"title":"Resume contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/resume","href":"/api-reference/contracts/resume-contract"},{"title":"Create contract phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/phases/{phase_id}/pricing","href":"/api-reference/contracts/create-contract-phase-pricing"},{"title":"Expire contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/expire","href":"/api-reference/contracts/expire-contract"}]},{"group":"Credit Notes","pages":[{"title":"Get credit note list","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes","href":"/api-reference/credit-notes/get-credit-note-list"},{"title":"Create credit note","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /credit_notes","href":"/api-reference/credit-notes/create-credit-note"},{"title":"Get credit note by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes/{credit_note_id}","href":"/api-reference/credit-notes/get-credit-note-by-id"},{"title":"Update credit note by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /credit_notes/{credit_note_id}","href":"/api-reference/credit-notes/update-credit-note-by-id"},{"title":"Get line items by credit note ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes/line_items/{credit_note_id}","href":"/api-reference/credit-notes/get-line-items-by-credit-note-id"}]},{"group":"Custom Attributes","pages":[{"title":"List custom attribute definitions","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /custom_attributes","href":"/api-reference/custom-attributes/list-custom-attribute-definitions"},{"title":"Create custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /custom_attributes","href":"/api-reference/custom-attributes/create-custom-attribute-definition"},{"title":"Get custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /custom_attributes/{definition_id}","href":"/api-reference/custom-attributes/get-custom-attribute-definition"},{"title":"Update custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /custom_attributes/{definition_id}","href":"/api-reference/custom-attributes/update-custom-attribute-definition"}]},{"group":"Customers","pages":[{"title":"List customers with filtering and pagination","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers","href":"/api-reference/customers/list-customers-with-filtering-and-pagination"},{"title":"Create customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers","href":"/api-reference/customers/create-customer"},{"title":"Get customer by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}","href":"/api-reference/customers/get-customer-by-id"},{"title":"Delete customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}","href":"/api-reference/customers/delete-customer"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}","href":"/api-reference/customers/update-customer"},{"title":"Create customer relationships","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/relationships","href":"/api-reference/customers/create-customer-relationships"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/payment_methods","href":"/api-reference/customers/list-payment-methods"},{"title":"Patch Customer Connector Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}/connector","href":"/api-reference/customers/patch-customer-connector-id"},{"title":"Attach external payment method","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/payment_methods/attach","href":"/api-reference/customers/attach-external-payment-method"},{"title":"Delete payment method","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}/payment_methods/{payment_method_id}","href":"/api-reference/customers/delete-payment-method"},{"title":"Delete third-party connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/connector/{customer_id}","href":"/api-reference/customers/delete-third-party-connector"},{"title":"Create customer or guest session","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/session","href":"/api-reference/customers/create-customer-or-guest-session"},{"title":"Get customer connector details","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/connector/{connector_name}","href":"/api-reference/customers/get-customer-connector-details"}]},{"group":"Customer Addresses","pages":[{"title":"List customer addresses","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/addresses","href":"/api-reference/customer-addresses/list-customer-addresses"},{"title":"Create customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/addresses","href":"/api-reference/customer-addresses/create-customer-address"},{"title":"Get customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/get-customer-address"},{"title":"Delete customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/delete-customer-address"},{"title":"Update customer address","description":"Update an existing address with partial data. Only provided fields will be updated.\n\n**Partial Updates:**\nThis endpoint supports partial updates - only include fields you want to change. Omitted fields will retain their current values.\n\n**Default Flag Behavior:**\n- Setting `is_default_billing: true` will unset the flag on all other addresses\n- Setting `is_default_shipping: true` will unset the flag on all other addresses\n- Only one address can be default billing and one can be default shipping at a time\n\n**Duplicate Prevention:**\nIf updating address fields would result in a duplicate of another existing address, the update will be rejected with a `DUPLICATE_ADDRESS` error. This ensures data integrity and prevents confusion in downstream systems.\n\n**Validation Status:**\nWhen address fields are modified, the validation_status may need to be re-verified through tax calculation services.","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/update-customer-address"}]},{"group":"Data Sources","pages":[{"title":"List data-source connectors","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /datasources","href":"/api-reference/data-sources/list-data-source-connectors"},{"title":"Create data-source connector","description":"Creates a data source for the given organisation. The data source will be associated with the organisation.","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /datasources","href":"/api-reference/data-sources/create-data-source-connector"},{"title":"Get data-source connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /datasources/{datasource_id}","href":"/api-reference/data-sources/get-data-source-connector"},{"title":"Update data-source connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /datasources/{datasource_id}","href":"/api-reference/data-sources/update-data-source-connector"}]},{"group":"Entitlements","pages":[{"title":"List entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements","href":"/api-reference/entitlements/list-entitlements"},{"title":"Create entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /entitlements","href":"/api-reference/entitlements/create-entitlement"},{"title":"List customer entitlement balances with advanced filtering","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customers_balances","href":"/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering"},{"title":"Get entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}","href":"/api-reference/entitlements/get-entitlement"},{"title":"Delete entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /entitlements/{entitlement_id}","href":"/api-reference/entitlements/delete-entitlement"},{"title":"Update entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /entitlements/{entitlement_id}","href":"/api-reference/entitlements/update-entitlement"},{"title":"Create entitlement customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /entitlements/{entitlement_id}/customer","href":"/api-reference/entitlements/create-entitlement-customer"},{"title":"List entitlements for customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}","href":"/api-reference/entitlements/list-entitlements-for-customer"},{"title":"Get total customer entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}/total","href":"/api-reference/entitlements/get-total-customer-entitlements"},{"title":"List customer entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customer/{customer_id}","href":"/api-reference/entitlements/list-customer-entitlements"},{"title":"List unique entitlements for customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customer/unique/{customer_id}","href":"/api-reference/entitlements/list-unique-entitlements-for-customer"},{"title":"Get entitlement customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/get-entitlement-customer"},{"title":"Delete customer entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/delete-customer-entitlement"},{"title":"Update customer entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/update-customer-entitlement"},{"title":"Get Customer Entitlement by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/entitlement_customer/{ec_id}","href":"/api-reference/entitlements/get-customer-entitlement-by-id"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/{invoice_id}","href":"/api-reference/invoices/get-invoice"},{"title":"Get invoice by external Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/external_id/{external_id}","href":"/api-reference/invoices/get-invoice-by-external-id"},{"title":"Generate an invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /invoices/generate_invoice","href":"/api-reference/invoices/generate-an-invoice"},{"title":"Approve invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/{invoice_id}/approve","href":"/api-reference/invoices/approve-invoice"},{"title":"Approve V3 invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/v3/{invoice_id}/approve","href":"/api-reference/invoices/approve-v3-invoice"},{"title":"Get invoice line items","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/{invoice_id}/line_items","href":"/api-reference/invoices/get-invoice-line-items"},{"title":"Void invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/{invoice_id}/void","href":"/api-reference/invoices/void-invoice"},{"title":"Create credit note against invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /invoices/{invoice_id}/credit_note","href":"/api-reference/invoices/create-credit-note-against-invoice"}]},{"group":"Jobs","pages":[{"title":"List jobs","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs","href":"/api-reference/jobs/list-jobs"},{"title":"Get job by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}","href":"/api-reference/jobs/get-job-by-id"},{"title":"Get job outcomes by filters","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/joboutcomes/logs","href":"/api-reference/jobs/get-job-outcomes-by-filters"},{"title":"Get job outcomes by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}/logs","href":"/api-reference/jobs/get-job-outcomes-by-id"},{"title":"Get job with sub-jobs","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}/sub-jobs","href":"/api-reference/jobs/get-job-with-sub-jobs"}]},{"group":"Payments","pages":[{"title":"Get invoice payments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments/invoice/{invoice_id}","href":"/api-reference/payments/get-invoice-payments"},{"title":"Get payment by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments/{payment_id}","href":"/api-reference/payments/get-payment-by-id"},{"title":"Delete manual payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /payments/{payment_id}","href":"/api-reference/payments/delete-manual-payment"},{"title":"Update payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /payments/{payment_id}","href":"/api-reference/payments/update-payment"},{"title":"Get payments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments","href":"/api-reference/payments/get-payments"},{"title":"Create payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments","href":"/api-reference/payments/create-payment"},{"title":"Create invoice charge","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments/invoice/{invoice_id}/charge","href":"/api-reference/payments/create-invoice-charge"},{"title":"Edit manual payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /payments/manual_payment/{payment_id}","href":"/api-reference/payments/edit-manual-payment"},{"title":"Refund payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments/{payment_id}/refund","href":"/api-reference/payments/refund-payment"}]},{"group":"Plans","pages":[{"title":"List plans","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /plans","href":"/api-reference/plans/list-plans"},{"title":"Create plan","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans","href":"/api-reference/plans/create-plan"},{"title":"Get plan by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /plans/{plan_id}","href":"/api-reference/plans/get-plan-by-id"},{"title":"Update plan","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}","href":"/api-reference/plans/update-plan"},{"title":"Delete plan by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}","href":"/api-reference/plans/delete-plan-by-id"},{"title":"Create plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/phases","href":"/api-reference/plans/create-plan-phase"},{"title":"Update plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}/phases/{phase_id}","href":"/api-reference/plans/update-plan-phase"},{"title":"Delete plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}/phases/{phase_id}","href":"/api-reference/plans/delete-plan-phase"},{"title":"Create plan phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/phases/{phase_id}/pricing","href":"/api-reference/plans/create-plan-phase-pricing"},{"title":"Update plan phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}/phases/{phase_id}/pricing/{phase_pricing_id}","href":"/api-reference/plans/update-plan-phase-pricing"},{"title":"Delete plan phase pricing by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}/phases/{phase_id}/pricing/{pricing_id}","href":"/api-reference/plans/delete-plan-phase-pricing-by-id"},{"title":"Create new version","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/new_version","href":"/api-reference/plans/create-new-version"}]},{"group":"Products","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products","href":"/api-reference/products/list-products"},{"title":"Create product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products","href":"/api-reference/products/create-product"},{"title":"Get product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}","href":"/api-reference/products/get-product"},{"title":"Delete product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /products/{product_id}","href":"/api-reference/products/delete-product"},{"title":"Update product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/{product_id}","href":"/api-reference/products/update-product"},{"title":"Get product pricings","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}/pricing","href":"/api-reference/products/get-product-pricings"},{"title":"Create product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products/{product_id}/pricing","href":"/api-reference/products/create-product-pricing"},{"title":"Get product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/get-product-pricing"},{"title":"Delete product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/delete-product-pricing"},{"title":"Update product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/update-product-pricing"},{"title":"Get product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/bundle/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/get-product-bundle-pricing"},{"title":"Update product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/bundle/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/update-product-bundle-pricing"},{"title":"Create product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products/bundle/{product_id}/pricing","href":"/api-reference/products/create-product-bundle-pricing"}]},{"group":"Tax","pages":[{"title":"List tax categories","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/categories","href":"/api-reference/tax/list-tax-categories"},{"title":"Create tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/categories","href":"/api-reference/tax/create-tax-category"},{"title":"Get tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/categories/{code}","href":"/api-reference/tax/get-tax-category"},{"title":"Update tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/categories/{code}","href":"/api-reference/tax/update-tax-category"},{"title":"List jurisdiction rates","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates","href":"/api-reference/tax/list-jurisdiction-rates"},{"title":"Create jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/business_entities/{business_entity_id}/jurisdiction_rates","href":"/api-reference/tax/create-jurisdiction-rate"},{"title":"Get jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}","href":"/api-reference/tax/get-jurisdiction-rate"},{"title":"Update jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}","href":"/api-reference/tax/update-jurisdiction-rate"},{"title":"Resolve the applicable tax rate for a destination","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/business_entities/{business_entity_id}/rates/lookup","href":"/api-reference/tax/resolve-the-applicable-tax-rate-for-a-destination"},{"title":"List tax rates","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}/rates","href":"/api-reference/tax/list-tax-rates"},{"title":"Get tax rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/rates/{rate_id}","href":"/api-reference/tax/get-tax-rate"},{"title":"Update tax rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/business_entities/{business_entity_id}/rates/{rate_id}","href":"/api-reference/tax/update-tax-rate"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tags/{holder}/{item_id}","href":"/api-reference/tags/list-tags"},{"title":"Upsert tags","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tags","href":"/api-reference/tags/upsert-tags"}]},{"group":"Usage Events","pages":[{"title":"List usage events","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics","href":"/api-reference/usage-events/list-usage-events"},{"title":"Create usage event","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /rawmetrics","href":"/api-reference/usage-events/create-usage-event"},{"title":"Get usage event by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics/{raw_metric_id}","href":"/api-reference/usage-events/get-usage-event-by-id"},{"title":"Update usage event","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /rawmetrics/{raw_metric_id}","href":"/api-reference/usage-events/update-usage-event"},{"title":"Get usage event by slug","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics/slug/{raw_metric_slug}","href":"/api-reference/usage-events/get-usage-event-by-slug"}]}]}]},{"version":"baobab.20240301","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/20240301/getting-started/introduction"}]},{"tab":"API Guides","pages":[{"title":"API Guides","href":"/20240301/api-guides/authentication"}]},{"tab":"API Reference","groups":[{"group":"Accounting","pages":[{"title":"Get chart of accounts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/chart_of_accounts","href":"/api-reference/accounting/get-chart-of-accounts"},{"title":"Get accounts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/accounts","href":"/api-reference/accounting/get-accounts"},{"title":"Create account","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/accounts","href":"/api-reference/accounting/create-account"},{"title":"Get close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/close_date","href":"/api-reference/accounting/get-close-date"},{"title":"Create close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/close_date","href":"/api-reference/accounting/create-close-date"},{"title":"Update close date","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /accounting_new/close_date","href":"/api-reference/accounting/update-close-date"},{"title":"Create journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/journal_entry","href":"/api-reference/accounting/create-journal-entry"},{"title":"Get journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_entry/{journal_entry_id}","href":"/api-reference/accounting/get-journal-entry"},{"title":"Update journal entry","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /accounting_new/journal_entry/{journal_entry_id}","href":"/api-reference/accounting/update-journal-entry"},{"title":"Get account balance by tag","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/accounts/{account_id}/balance","href":"/api-reference/accounting/get-account-balance-by-tag"},{"title":"Get journal entries","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_entries","href":"/api-reference/accounting/get-journal-entries"},{"title":"Get journal lines","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/journal_lines","href":"/api-reference/accounting/get-journal-lines"},{"title":"Get balance sheet","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/balance_sheet/v2","href":"/api-reference/accounting/get-balance-sheet"},{"title":"Get income statement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/income_statement/v2","href":"/api-reference/accounting/get-income-statement"},{"title":"Validate period close","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/periods/validate-close","href":"/api-reference/accounting/validate-period-close"},{"title":"Close accounting period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /accounting_new/periods/close","href":"/api-reference/accounting/close-accounting-period"},{"title":"Get accounting periods","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods","href":"/api-reference/accounting/get-accounting-periods"},{"title":"Get last closed period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods/last","href":"/api-reference/accounting/get-last-closed-period"},{"title":"Get accounting period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /accounting_new/periods/{period_id}","href":"/api-reference/accounting/get-accounting-period"}]},{"group":"Billable Metrics","pages":[{"title":"List billable metrics","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates","href":"/api-reference/billable-metrics/list-billable-metrics"},{"title":"Create billable metric","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /aggregates","href":"/api-reference/billable-metrics/create-billable-metric"},{"title":"Get aggregate estimates for a period","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates/estimates","href":"/api-reference/billable-metrics/get-aggregate-estimates-for-a-period"},{"title":"Get billable metric","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/get-billable-metric"},{"title":"Delete aggregate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/delete-aggregate"},{"title":"Update aggregate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /aggregates/{aggregate_id}","href":"/api-reference/billable-metrics/update-aggregate"}]},{"group":"Business Entities","pages":[{"title":"List business entities","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities","href":"/api-reference/business-entities/list-business-entities"},{"title":"Create business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /business_entities","href":"/api-reference/business-entities/create-business-entity"},{"title":"Get business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{entity_id}","href":"/api-reference/business-entities/get-business-entity"},{"title":"Update business entity","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /business_entities/{entity_id}","href":"/api-reference/business-entities/update-business-entity"},{"title":"Get business entity config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{business_entity_id}/config","href":"/api-reference/business-entities/get-business-entity-config"},{"title":"Set business entity config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /business_entities/{business_entity_id}/config","href":"/api-reference/business-entities/set-business-entity-config"},{"title":"Get region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/get-region-config"},{"title":"Upsert region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/upsert-region-config"},{"title":"Delete region config","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /business_entities/{business_entity_id}/config/{country_code}","href":"/api-reference/business-entities/delete-region-config"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contacts","href":"/api-reference/contacts/create-contact"},{"title":"Get contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contacts/{contact_id}","href":"/api-reference/contacts/get-contact"},{"title":"Delete contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /contacts/{contact_id}","href":"/api-reference/contacts/delete-contact"},{"title":"Update contact","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contacts/{contact_id}","href":"/api-reference/contacts/update-contact"}]},{"group":"Contracts","pages":[{"title":"List contracts","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2","href":"/api-reference/contracts/list-contracts"},{"title":"Create contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2","href":"/api-reference/contracts/create-contract"},{"title":"Get contract by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2/{contract_id}","href":"/api-reference/contracts/get-contract-by-id"},{"title":"Update contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /contract_v2/{contract_id}","href":"/api-reference/contracts/update-contract"},{"title":"Delete contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /contract_v2/{contract_id}","href":"/api-reference/contracts/delete-contract"},{"title":"Get contract amendments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /contract_v2/{contract_id}/amendments","href":"/api-reference/contracts/get-contract-amendments"},{"title":"Create contract phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/phases","href":"/api-reference/contracts/create-contract-phase"},{"title":"Pause contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/pause","href":"/api-reference/contracts/pause-contract"},{"title":"Update pause contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/pause","href":"/api-reference/contracts/update-pause-contract"},{"title":"Resume contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/resume","href":"/api-reference/contracts/resume-contract"},{"title":"Create contract phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /contract_v2/{contract_id}/phases/{phase_id}/pricing","href":"/api-reference/contracts/create-contract-phase-pricing"},{"title":"Expire contract","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /contract_v2/{contract_id}/expire","href":"/api-reference/contracts/expire-contract"}]},{"group":"Credit Notes","pages":[{"title":"Get credit note list","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes","href":"/api-reference/credit-notes/get-credit-note-list"},{"title":"Create credit note","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /credit_notes","href":"/api-reference/credit-notes/create-credit-note"},{"title":"Get credit note by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes/{credit_note_id}","href":"/api-reference/credit-notes/get-credit-note-by-id"},{"title":"Update credit note by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /credit_notes/{credit_note_id}","href":"/api-reference/credit-notes/update-credit-note-by-id"},{"title":"Get line items by credit note ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /credit_notes/line_items/{credit_note_id}","href":"/api-reference/credit-notes/get-line-items-by-credit-note-id"}]},{"group":"Custom Attributes","pages":[{"title":"List custom attribute definitions","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /custom_attributes","href":"/api-reference/custom-attributes/list-custom-attribute-definitions"},{"title":"Create custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /custom_attributes","href":"/api-reference/custom-attributes/create-custom-attribute-definition"},{"title":"Get custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /custom_attributes/{definition_id}","href":"/api-reference/custom-attributes/get-custom-attribute-definition"},{"title":"Update custom attribute definition","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /custom_attributes/{definition_id}","href":"/api-reference/custom-attributes/update-custom-attribute-definition"}]},{"group":"Customers","pages":[{"title":"List customers with filtering and pagination","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers","href":"/api-reference/customers/list-customers-with-filtering-and-pagination"},{"title":"Create customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers","href":"/api-reference/customers/create-customer"},{"title":"Get customer by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}","href":"/api-reference/customers/get-customer-by-id"},{"title":"Delete customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}","href":"/api-reference/customers/delete-customer"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}","href":"/api-reference/customers/update-customer"},{"title":"Create customer relationships","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/relationships","href":"/api-reference/customers/create-customer-relationships"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/payment_methods","href":"/api-reference/customers/list-payment-methods"},{"title":"Patch Customer Connector Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}/connector","href":"/api-reference/customers/patch-customer-connector-id"},{"title":"Attach external payment method","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/payment_methods/attach","href":"/api-reference/customers/attach-external-payment-method"},{"title":"Delete payment method","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}/payment_methods/{payment_method_id}","href":"/api-reference/customers/delete-payment-method"},{"title":"Delete third-party connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/connector/{customer_id}","href":"/api-reference/customers/delete-third-party-connector"},{"title":"Create customer or guest session","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/session","href":"/api-reference/customers/create-customer-or-guest-session"},{"title":"Get customer connector details","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/connector/{connector_name}","href":"/api-reference/customers/get-customer-connector-details"}]},{"group":"Customer Addresses","pages":[{"title":"List customer addresses","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/addresses","href":"/api-reference/customer-addresses/list-customer-addresses"},{"title":"Create customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /customers/{customer_id}/addresses","href":"/api-reference/customer-addresses/create-customer-address"},{"title":"Get customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/get-customer-address"},{"title":"Delete customer address","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/delete-customer-address"},{"title":"Update customer address","description":"Update an existing address with partial data. Only provided fields will be updated.\n\n**Partial Updates:**\nThis endpoint supports partial updates - only include fields you want to change. Omitted fields will retain their current values.\n\n**Default Flag Behavior:**\n- Setting `is_default_billing: true` will unset the flag on all other addresses\n- Setting `is_default_shipping: true` will unset the flag on all other addresses\n- Only one address can be default billing and one can be default shipping at a time\n\n**Duplicate Prevention:**\nIf updating address fields would result in a duplicate of another existing address, the update will be rejected with a `DUPLICATE_ADDRESS` error. This ensures data integrity and prevents confusion in downstream systems.\n\n**Validation Status:**\nWhen address fields are modified, the validation_status may need to be re-verified through tax calculation services.","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /customers/{customer_id}/addresses/{address_id}","href":"/api-reference/customer-addresses/update-customer-address"}]},{"group":"Data Sources","pages":[{"title":"List data-source connectors","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /datasources","href":"/api-reference/data-sources/list-data-source-connectors"},{"title":"Create data-source connector","description":"Creates a data source for the given organisation. The data source will be associated with the organisation.","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /datasources","href":"/api-reference/data-sources/create-data-source-connector"},{"title":"Get data-source connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /datasources/{datasource_id}","href":"/api-reference/data-sources/get-data-source-connector"},{"title":"Update data-source connector","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /datasources/{datasource_id}","href":"/api-reference/data-sources/update-data-source-connector"}]},{"group":"Entitlements","pages":[{"title":"List entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements","href":"/api-reference/entitlements/list-entitlements"},{"title":"Create entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /entitlements","href":"/api-reference/entitlements/create-entitlement"},{"title":"List customer entitlement balances with advanced filtering","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customers_balances","href":"/api-reference/entitlements/list-customer-entitlement-balances-with-advanced-filtering"},{"title":"Get entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}","href":"/api-reference/entitlements/get-entitlement"},{"title":"Delete entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /entitlements/{entitlement_id}","href":"/api-reference/entitlements/delete-entitlement"},{"title":"Update entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /entitlements/{entitlement_id}","href":"/api-reference/entitlements/update-entitlement"},{"title":"Create entitlement customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /entitlements/{entitlement_id}/customer","href":"/api-reference/entitlements/create-entitlement-customer"},{"title":"List entitlements for customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}","href":"/api-reference/entitlements/list-entitlements-for-customer"},{"title":"Get total customer entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}/total","href":"/api-reference/entitlements/get-total-customer-entitlements"},{"title":"List customer entitlements","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customer/{customer_id}","href":"/api-reference/entitlements/list-customer-entitlements"},{"title":"List unique entitlements for customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/customer/unique/{customer_id}","href":"/api-reference/entitlements/list-unique-entitlements-for-customer"},{"title":"Get entitlement customer","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/get-entitlement-customer"},{"title":"Delete customer entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/delete-customer-entitlement"},{"title":"Update customer entitlement","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /entitlements/{entitlement_id}/customer/{customer_id}/{ec_id}","href":"/api-reference/entitlements/update-customer-entitlement"},{"title":"Get Customer Entitlement by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /entitlements/entitlement_customer/{ec_id}","href":"/api-reference/entitlements/get-customer-entitlement-by-id"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/{invoice_id}","href":"/api-reference/invoices/get-invoice"},{"title":"Get invoice by external Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/external_id/{external_id}","href":"/api-reference/invoices/get-invoice-by-external-id"},{"title":"Generate an invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /invoices/generate_invoice","href":"/api-reference/invoices/generate-an-invoice"},{"title":"Approve invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/{invoice_id}/approve","href":"/api-reference/invoices/approve-invoice"},{"title":"Approve V3 invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/v3/{invoice_id}/approve","href":"/api-reference/invoices/approve-v3-invoice"},{"title":"Get invoice line items","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /invoices/{invoice_id}/line_items","href":"/api-reference/invoices/get-invoice-line-items"},{"title":"Void invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /invoices/{invoice_id}/void","href":"/api-reference/invoices/void-invoice"},{"title":"Create credit note against invoice","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /invoices/{invoice_id}/credit_note","href":"/api-reference/invoices/create-credit-note-against-invoice"}]},{"group":"Jobs","pages":[{"title":"List jobs","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs","href":"/api-reference/jobs/list-jobs"},{"title":"Get job by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}","href":"/api-reference/jobs/get-job-by-id"},{"title":"Get job outcomes by filters","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/joboutcomes/logs","href":"/api-reference/jobs/get-job-outcomes-by-filters"},{"title":"Get job outcomes by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}/logs","href":"/api-reference/jobs/get-job-outcomes-by-id"},{"title":"Get job with sub-jobs","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /jobs/{job_id}/sub-jobs","href":"/api-reference/jobs/get-job-with-sub-jobs"}]},{"group":"Payments","pages":[{"title":"Get invoice payments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments/invoice/{invoice_id}","href":"/api-reference/payments/get-invoice-payments"},{"title":"Get payment by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments/{payment_id}","href":"/api-reference/payments/get-payment-by-id"},{"title":"Delete manual payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /payments/{payment_id}","href":"/api-reference/payments/delete-manual-payment"},{"title":"Update payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /payments/{payment_id}","href":"/api-reference/payments/update-payment"},{"title":"Get payments","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /payments","href":"/api-reference/payments/get-payments"},{"title":"Create payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments","href":"/api-reference/payments/create-payment"},{"title":"Create invoice charge","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments/invoice/{invoice_id}/charge","href":"/api-reference/payments/create-invoice-charge"},{"title":"Edit manual payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /payments/manual_payment/{payment_id}","href":"/api-reference/payments/edit-manual-payment"},{"title":"Refund payment","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /payments/{payment_id}/refund","href":"/api-reference/payments/refund-payment"}]},{"group":"Plans","pages":[{"title":"List plans","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /plans","href":"/api-reference/plans/list-plans"},{"title":"Create plan","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans","href":"/api-reference/plans/create-plan"},{"title":"Get plan by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /plans/{plan_id}","href":"/api-reference/plans/get-plan-by-id"},{"title":"Update plan","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}","href":"/api-reference/plans/update-plan"},{"title":"Delete plan by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}","href":"/api-reference/plans/delete-plan-by-id"},{"title":"Create plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/phases","href":"/api-reference/plans/create-plan-phase"},{"title":"Update plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}/phases/{phase_id}","href":"/api-reference/plans/update-plan-phase"},{"title":"Delete plan phase","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}/phases/{phase_id}","href":"/api-reference/plans/delete-plan-phase"},{"title":"Create plan phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/phases/{phase_id}/pricing","href":"/api-reference/plans/create-plan-phase-pricing"},{"title":"Update plan phase pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json put /plans/{plan_id}/phases/{phase_id}/pricing/{phase_pricing_id}","href":"/api-reference/plans/update-plan-phase-pricing"},{"title":"Delete plan phase pricing by Id","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /plans/{plan_id}/phases/{phase_id}/pricing/{pricing_id}","href":"/api-reference/plans/delete-plan-phase-pricing-by-id"},{"title":"Create new version","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /plans/{plan_id}/new_version","href":"/api-reference/plans/create-new-version"}]},{"group":"Products","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products","href":"/api-reference/products/list-products"},{"title":"Create product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products","href":"/api-reference/products/create-product"},{"title":"Get product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}","href":"/api-reference/products/get-product"},{"title":"Delete product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /products/{product_id}","href":"/api-reference/products/delete-product"},{"title":"Update product","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/{product_id}","href":"/api-reference/products/update-product"},{"title":"Get product pricings","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}/pricing","href":"/api-reference/products/get-product-pricings"},{"title":"Create product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products/{product_id}/pricing","href":"/api-reference/products/create-product-pricing"},{"title":"Get product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/get-product-pricing"},{"title":"Delete product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json delete /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/delete-product-pricing"},{"title":"Update product pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/update-product-pricing"},{"title":"Get product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /products/bundle/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/get-product-bundle-pricing"},{"title":"Update product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /products/bundle/{product_id}/pricing/{pricing_id}","href":"/api-reference/products/update-product-bundle-pricing"},{"title":"Create product bundle pricing","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /products/bundle/{product_id}/pricing","href":"/api-reference/products/create-product-bundle-pricing"}]},{"group":"Tax","pages":[{"title":"List tax categories","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/categories","href":"/api-reference/tax/list-tax-categories"},{"title":"Create tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/categories","href":"/api-reference/tax/create-tax-category"},{"title":"Get tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/categories/{code}","href":"/api-reference/tax/get-tax-category"},{"title":"Update tax category","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/categories/{code}","href":"/api-reference/tax/update-tax-category"},{"title":"List jurisdiction rates","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates","href":"/api-reference/tax/list-jurisdiction-rates"},{"title":"Create jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/business_entities/{business_entity_id}/jurisdiction_rates","href":"/api-reference/tax/create-jurisdiction-rate"},{"title":"Get jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}","href":"/api-reference/tax/get-jurisdiction-rate"},{"title":"Update jurisdiction rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}","href":"/api-reference/tax/update-jurisdiction-rate"},{"title":"Resolve the applicable tax rate for a destination","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tax/business_entities/{business_entity_id}/rates/lookup","href":"/api-reference/tax/resolve-the-applicable-tax-rate-for-a-destination"},{"title":"List tax rates","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/jurisdiction_rates/{jurisdiction_rate_id}/rates","href":"/api-reference/tax/list-tax-rates"},{"title":"Get tax rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tax/business_entities/{business_entity_id}/rates/{rate_id}","href":"/api-reference/tax/get-tax-rate"},{"title":"Update tax rate","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /tax/business_entities/{business_entity_id}/rates/{rate_id}","href":"/api-reference/tax/update-tax-rate"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /tags/{holder}/{item_id}","href":"/api-reference/tags/list-tags"},{"title":"Upsert tags","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /tags","href":"/api-reference/tags/upsert-tags"}]},{"group":"Usage Events","pages":[{"title":"List usage events","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics","href":"/api-reference/usage-events/list-usage-events"},{"title":"Create usage event","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json post /rawmetrics","href":"/api-reference/usage-events/create-usage-event"},{"title":"Get usage event by ID","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics/{raw_metric_id}","href":"/api-reference/usage-events/get-usage-event-by-id"},{"title":"Update usage event","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json patch /rawmetrics/{raw_metric_id}","href":"/api-reference/usage-events/update-usage-event"},{"title":"Get usage event by slug","deprecated":null,"version":null,"openapi":"/openAPI/openapi-20240301.json get /rawmetrics/slug/{raw_metric_slug}","href":"/api-reference/usage-events/get-usage-event-by-slug"}]}]}]}]},"title":"List data-source connectors - Zenskar Documentation","buildId":"dpl_DGmhKsAzJdVqypJzon18vViniWRY","deploymentId":"dpl_DGmhKsAzJdVqypJzon18vViniWRY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-2jF_ccbi.js","utils-NNMVb_sb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DdtBhtt6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D1OxL5O8.js","snippetPresets-DDC-KAXp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BOnTqOyQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-EEWI6FIO.js","shallow-fGZcWzm2.js","getApiPlaygroundDisplay-B3B8qEvw.js","CodeSnippet-BG9nsSU4.js","CodeSnippets-BlRACLKl.js","Page-FtoC8lZ9.js","getPastedJson-COV-Kgnr.js","icon-BXu3lasn.js","MethodPill-DGMUqJKh.js","DuplicateIcon-JEUJDHz_.js","createIcon-BDFucJ34.js","DynamicMarkdown-34OtG_BH.js","SectionHeading-tBbRD59j.js","axios-vUo_bRtp.js","Markdown-SoRz2nk2.js","clsx-BOmkPVIU.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DN0dCbTw.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BcsLYcfW.js"]}