**Get integration state**
Read workspace connections, provider authorization, import fields, and initial import progress. Pass query: {kind: workspace} to confirm the destination workspace, signed-in email, supported providers, and current connections. Pass {kind: request, request_id} for an authorization request, or {kind: connection, source, account_id, etl_id} for import status; add fields: true inside the connection query to inspect optional import fields. For Salesforce, use {kind: objects, source: salesforce, account_id, etl_id} instead of fields: true to list available objects. Results are returned in the setup object.
status.workspaceTableId is the readable Rippit table id; pass it as workspace_table_id to describe_table, read_table, or aggregate_table. status.tableId is an internal id and must not be passed to those tools. If workspaceTableId is absent, discover the table before reading it.
Salesforce status.tables lists each selected object, its progress, and its workspaceTableId. Use those readable ids for table tools. The overall state stays importing until all selected tables finish; do not infer completion from Cases alone. objects[].doFullRepull means that object imports all history regardless of history_days.
Authorization request status completed means authorized, not imported. A ready initial import does not guarantee complete history; match the connection's ETL id to the resulting table and check coverage before analysis. Report status.warning and do not retry a ready import. Use connect_integration for authorization. Use import_integration to start or retry an import.
Wait up to 45 seconds for authorization or import progress to finish. Omit for an immediate check. Return to the user after a bounded wait; do not poll indefinitely.
Required range: 0 <= x <= 45
Response
200
Tool result.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Rippit","description":"Rippit product documentation","colors":{"primary":"#079669","light":"#56b98f","dark":"#008156"},"logo":{"light":"https://mintcdn.com/rippit-ddefb232/uzkTtzpXlUcSK32Q/logo/light.svg?fit=max\u0026auto=format\u0026n=uzkTtzpXlUcSK32Q\u0026q=85\u0026s=8950a1dcb68093d7ac8370f0f847f209","dark":"https://mintcdn.com/rippit-ddefb232/za2WGhSTe9ZLSBxZ/logo/dark.svg?fit=max\u0026auto=format\u0026n=za2WGhSTe9ZLSBxZ\u0026q=85\u0026s=8d626999b237e3103f24ffd34727bbd0"},"favicon":"https://mintcdn.com/rippit-ddefb232/uzkTtzpXlUcSK32Q/favicon.svg?fit=max\u0026auto=format\u0026n=uzkTtzpXlUcSK32Q\u0026q=85\u0026s=18b85aa33156e5e27477e6f3bc3a4242","navbar":{"links":[{"href":"https://status.rippit.com","label":"Status"}],"primary":{"type":"button","label":"Open Rippit","href":"https://app.rippit.com"}},"footer":{"socials":{}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"rippit-ddefb232","hasAudioNarration":false,"actualSubdomain":"rippit-ddefb232","customDomains":["docs.rippit.com"],"gitSource":{"type":"github","owner":"adtribute","repo":"analytics","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af12f972c3c90c870ace2bf","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Guides","count":89},{"language":"default","tag":"Connect your Data","count":44},{"language":"default","tag":"API reference","count":44},{"language":"default","tag":"MCP servers","count":29},{"language":"default","tag":"MCP Server details","count":27},{"language":"default","tag":"Connect data","count":27},{"language":"default","tag":"Connect your AI Agent","count":21},{"language":"default","tag":"AI Agent Details","count":17},{"language":"default","tag":"Data integrations","count":15},{"language":"default","tag":"Bulk API","count":14}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#pagination{display:none}"}],"page":{"pagePath":"api-reference/get_integration_state","slug":"/api-reference/get_integration_state","pageMetadata":{"title":"get_integration_state","description":"**Get integration state**\n\nRead workspace connections, provider authorization, import fields, and initial import progress. Pass query: {kind: workspace} to confirm the destination workspace, signed-in email, supported providers, and current connections. Pass {kind: request, request_id} for an authorization request, or {kind: connection, source, account_id, etl_id} for import status; add fields: true inside the connection query to inspect optional import fields. For Salesforce, use {kind: objects, source: salesforce, account_id, etl_id} instead of fields: true to list available objects. Results are returned in the setup object.\n\nstatus.workspaceTableId is the readable Rippit table id; pass it as workspace_table_id to describe_table, read_table, or aggregate_table. status.tableId is an internal id and must not be passed to those tools. If workspaceTableId is absent, discover the table before reading it.\n\nSalesforce status.tables lists each selected object, its progress, and its workspaceTableId. Use those readable ids for table tools. The overall state stays importing until all selected tables finish; do not infer completion from Cases alone. objects[].doFullRepull means that object imports all history regardless of history_days.\n\nAuthorization request status completed means authorized, not imported. A ready initial import does not guarantee complete history; match the connection's ETL id to the resulting table and check coverage before analysis. Report status.warning and do not retry a ready import. Use connect_integration for authorization. Use import_integration to start or retry an import.","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/get_integration_state","href":"/api-reference/get_integration_state","autogeneratedByOpenApi":true},"description":"**Get integration state**\n\nRead workspace connections, provider authorization, import fields, and initial import progress. Pass query: {kind: workspace} to confirm the destination workspace, signed-in email, supported providers, and current connections. Pass {kind: request, request_id} for an authorization request, or {kind: connection, source, account_id, etl_id} for import status; add fields: true inside the connection query to inspect optional import fields. For Salesforce, use {kind: objects, source: salesforce, account_id, etl_id} instead of fields: true to list available objects. Results are returned in the setup object.\n\nstatus.workspaceTableId is the readable Rippit table id; pass it as workspace_table_id to describe_table, read_table, or aggregate_table. status.tableId is an internal id and must not be passed to those tools. If workspaceTableId is absent, discover the table before reading it.\n\nSalesforce status.tables lists each selected object, its progress, and its workspaceTableId. Use those readable ids for table tools. The overall state stays importing until all selected tables finish; do not infer completion from Cases alone. objects[].doFullRepull means that object imports all history regardless of history_days.\n\nAuthorization request status completed means authorized, not imported. A ready initial import does not guarantee complete history; match the connection's ETL id to the resulting table and check coverage before analysis. Report status.warning and do not retry a ready import. Use connect_integration for authorization. Use import_integration to start or retry an import.","pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"get_integration_state","description":"**Get integration state**\n\nRead workspace connections, provider authorization, import fields, and initial import progress. Pass query: {kind: workspace} to confirm the destination workspace, signed-in email, supported providers, and current connections. Pass {kind: request, request_id} for an authorization request, or {kind: connection, source, account_id, etl_id} for import status; add fields: true inside the connection query to inspect optional import fields. For Salesforce, use {kind: objects, source: salesforce, account_id, etl_id} instead of fields: true to list available objects. Results are returned in the setup object.\n\nstatus.workspaceTableId is the readable Rippit table id; pass it as workspace_table_id to describe_table, read_table, or aggregate_table. status.tableId is an internal id and must not be passed to those tools. If workspaceTableId is absent, discover the table before reading it.\n\nSalesforce status.tables lists each selected object, its progress, and its workspaceTableId. Use those readable ids for table tools. The overall state stays importing until all selected tables finish; do not infer completion from Cases alone. objects[].doFullRepull means that object imports all history regardless of history_days.\n\nAuthorization request status completed means authorized, not imported. A ready initial import does not guarantee complete history; match the connection's ETL id to the resulting table and check coverage before analysis. Report status.warning and do not retry a ready import. Use connect_integration for authorization. Use import_integration to start or retry an import.","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/get_integration_state","href":"/api-reference/get_integration_state","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"get_integration_state","summary":"get_integration_state","description":"**Get integration state**\n\nRead workspace connections, provider authorization, import fields, and initial import progress. Pass query: {kind: workspace} to confirm the destination workspace, signed-in email, supported providers, and current connections. Pass {kind: request, request_id} for an authorization request, or {kind: connection, source, account_id, etl_id} for import status; add fields: true inside the connection query to inspect optional import fields. For Salesforce, use {kind: objects, source: salesforce, account_id, etl_id} instead of fields: true to list available objects. Results are returned in the setup object.\n\nstatus.workspaceTableId is the readable Rippit table id; pass it as workspace_table_id to describe_table, read_table, or aggregate_table. status.tableId is an internal id and must not be passed to those tools. If workspaceTableId is absent, discover the table before reading it.\n\nSalesforce status.tables lists each selected object, its progress, and its workspaceTableId. Use those readable ids for table tools. The overall state stays importing until all selected tables finish; do not infer completion from Cases alone. objects[].doFullRepull means that object imports all history regardless of history_days.\n\nAuthorization request status completed means authorized, not imported. A ready initial import does not guarantee complete history; match the connection's ETL id to the resulting table and check coverage before analysis. Report status.warning and do not retry a ready import. Use connect_integration for authorization. Use import_integration to start or retry an import.","requestBody":"8854b289-09f5-42a7-ae71-062e392114ea","responses":{"200":"95218d6d-74dc-4768-bc80-bd1fa3e7a737"},"x-mint":{"metadata":{"playground":"none"}},"method":"post","type":"path","servers":["adeb82bd-a22a-4c6a-98ee-f48b86a1e79d"],"security":["44493fb5-0be1-4fe2-8ec1-c85fcb9b4491"],"path":"/v1/get_integration_state","baseUrlOptions":["https://api.rippit.com"],"title":"get_integration_state","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"oneOf":[{"type":"object","description":"Inspect the workspace, an authorization attempt, a connected provider, or available Salesforce import objects.","required":["kind"],"properties":{"kind":{"type":"string","const":"workspace","isRequired":true,"uniqueKey":"query.oneOf.0.kind","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"query.oneOf.0","typeLabel":"object"},{"type":"object","description":"Inspect the workspace, an authorization attempt, a connected provider, or available Salesforce import objects.","required":["kind","request_id"],"properties":{"kind":{"type":"string","const":"request","isRequired":true,"uniqueKey":"query.oneOf.1.kind","typeLabel":"string"},"request_id":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"query.oneOf.1.request_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"query.oneOf.1","typeLabel":"object"},{"type":"object","description":"Inspect the workspace, an authorization attempt, a connected provider, or available Salesforce import objects.","required":["kind","source","account_id","etl_id"],"properties":{"kind":{"type":"string","const":"objects","isRequired":true,"uniqueKey":"query.oneOf.2.kind","typeLabel":"string"},"source":{"type":"string","const":"salesforce","isRequired":true,"uniqueKey":"query.oneOf.2.source","typeLabel":"string"},"account_id":{"type":"string","minLength":1,"maxLength":255,"description":"Exact provider account id returned by get_integration_state.","isRequired":true,"uniqueKey":"query.oneOf.2.account_id","typeLabel":"string"},"etl_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"ETL id of that same connection.","isRequired":true,"uniqueKey":"query.oneOf.2.etl_id","typeLabel":"integer"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"query.oneOf.2","typeLabel":"object"},{"type":"object","description":"Inspect the workspace, an authorization attempt, a connected provider, or available Salesforce import objects.","required":["kind","source","account_id","etl_id"],"properties":{"kind":{"type":"string","const":"connection","isRequired":true,"uniqueKey":"query.oneOf.3.kind","typeLabel":"string"},"source":{"type":"string","enum":["zendesk","intercom","slack_ingest","gong","salesforce"],"description":"Provider returned by get_integration_state.","isRequired":true,"uniqueKey":"query.oneOf.3.source","typeLabel":"enum\u003cstring>"},"account_id":{"type":"string","minLength":1,"maxLength":255,"description":"Exact provider account id returned by get_integration_state.","isRequired":true,"uniqueKey":"query.oneOf.3.account_id","typeLabel":"string"},"etl_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"ETL id of that same connection.","isRequired":true,"uniqueKey":"query.oneOf.3.etl_id","typeLabel":"integer"},"fields":{"description":"Read available import fields instead of import progress.","type":"boolean","uniqueKey":"query.oneOf.3.fields","typeLabel":"boolean"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"query.oneOf.3","typeLabel":"object"}],"isRequired":true,"uniqueKey":"query","typeLabel":"object"},"wait_seconds":{"description":"Wait up to 45 seconds for authorization or import progress to finish. Omit for an immediate check. Return to the user after a bounded wait; do not poll indefinitely.","type":"integer","minimum":0,"maximum":45,"uniqueKey":"wait_seconds","typeLabel":"integer"}},"required":["query"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"query":{"kind":"workspace"},"wait_seconds":22}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"95218d6d-74dc-4768-bc80-bd1fa3e7a737":{"description":"Tool result.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"44493fb5-0be1-4fe2-8ec1-c85fcb9b4491":{"bearer":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer"}}},"servers":{"adeb82bd-a22a-4c6a-98ee-f48b86a1e79d":{"url":"https://api.rippit.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/tools-openapi.json"},"subdomain":"rippit-ddefb232","siteName":"Rippit","title":"get_integration_state - Rippit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T01:29:32.244Z","originalFileLocation":"api-reference/get_integration_state.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=\"Get integration state Read workspace connections, provider authorization, import fields, and initial import progress. Pass query: {kind: workspace} to confirm the destination workspace, signed-in email, supported providers, and current connections. Pass {kind: request, request_id} for an authorization request, or {kind: connection, source, account_id, etl_id} for import status; add fields: true inside the connection query to inspect optional import fields. For Salesforce, use {kind: objects, source: salesforce, account_id, etl_id} instead of fields: true to list available objects. Results are returned in the setup object. status.workspaceTableId is the readable Rippit table id; pass it as workspace_table_id to describe_table, read_table, or aggregate_table. status.tableId is an internal id and must not be passed to those tools. If workspaceTableId is absent, discover the table before reading it. Salesforce status.tables lists each selected object, its progress, and its workspaceTableId. Use those readable ids for table tools. The overall state stays importing until all selected tables finish; do not infer completion from Cases alone. objects[].doFullRepull means that object imports all history regardless of history_days. Authorization request status completed means authorized, not imported. A ready initial import does not guarantee complete history; match the connection\u0026#x27;s ETL id to the resulting table and check coverage before analysis. Report status.warning and do not retry a ready import. Use connect_integration for authorization. Use import_integration to start or retry an import.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Rippit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rippit-ddefb232/u1OvlVJ9fpltsljb/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/rippit-ddefb232/u1OvlVJ9fpltsljb/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rippit-ddefb232/u1OvlVJ9fpltsljb/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rippit-ddefb232/u1OvlVJ9fpltsljb/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rippit-ddefb232/u1OvlVJ9fpltsljb/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rippit-ddefb232/u1OvlVJ9fpltsljb/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rippit-ddefb232/u1OvlVJ9fpltsljb/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rippit-ddefb232/u1OvlVJ9fpltsljb/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rippit-ddefb232/u1OvlVJ9fpltsljb/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"get_integration_state - Rippit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get integration state Read workspace connections, provider authorization, import fields, and initial import progress. Pass query: {kind: workspace} to confirm the destination workspace, signed-in email, supported providers, and current connections. Pass {kind: request, request_id} for an authorization request, or {kind: connection, source, account_id, etl_id} for import status; add fields: true inside the connection query to inspect optional import fields. For Salesforce, use {kind: objects, source: salesforce, account_id, etl_id} instead of fields: true to list available objects. Results are returned in the setup object. status.workspaceTableId is the readable Rippit table id; pass it as workspace_table_id to describe_table, read_table, or aggregate_table. status.tableId is an internal id and must not be passed to those tools. If workspaceTableId is absent, discover the table before reading it. Salesforce status.tables lists each selected object, its progress, and its workspaceTableId. Use those readable ids for table tools. The overall state stays importing until all selected tables finish; do not infer completion from Cases alone. objects[].doFullRepull means that object imports all history regardless of history_days. Authorization request status completed means authorized, not imported. A ready initial import does not guarantee complete history; match the connection\u0026#x27;s ETL id to the resulting table and check coverage before analysis. Report status.warning and do not retry a ready import. Use connect_integration for authorization. Use import_integration to start or retry an import.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Rippit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.rippit.com/api-reference/get_integration_state\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://rippit-ddefb232.mintlify.site/_mintlify/api/og/v2?division=Built-in+integrations\u0026amp;title=get_integration_state\u0026amp;description=**Get+integration+state**%0A%0ARead+workspace+connections%2C+provider+authorization%2C+import+fields%2C+and+initial+import+progress.+Pass+query%3A+%7Bkind%3A+workspace%7D+to+conf\u0026amp;theme=cc7de14802162a79d7966e1d\u0026amp;signature=297a3637cc8260607c1033653889551d3dce637d50f7f03d5bcaf90d94c72d78\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"get_integration_state - Rippit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get integration state Read workspace connections, provider authorization, import fields, and initial import progress. Pass query: {kind: workspace} to confirm the destination workspace, signed-in email, supported providers, and current connections. Pass {kind: request, request_id} for an authorization request, or {kind: connection, source, account_id, etl_id} for import status; add fields: true inside the connection query to inspect optional import fields. For Salesforce, use {kind: objects, source: salesforce, account_id, etl_id} instead of fields: true to list available objects. Results are returned in the setup object. status.workspaceTableId is the readable Rippit table id; pass it as workspace_table_id to describe_table, read_table, or aggregate_table. status.tableId is an internal id and must not be passed to those tools. If workspaceTableId is absent, discover the table before reading it. Salesforce status.tables lists each selected object, its progress, and its workspaceTableId. Use those readable ids for table tools. The overall state stays importing until all selected tables finish; do not infer completion from Cases alone. objects[].doFullRepull means that object imports all history regardless of history_days. Authorization request status completed means authorized, not imported. A ready initial import does not guarantee complete history; match the connection\u0026#x27;s ETL id to the resulting table and check coverage before analysis. Report status.warning and do not retry a ready import. Use connect_integration for authorization. Use import_integration to start or retry an import.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rippit-ddefb232.mintlify.site/_mintlify/api/og/v2?division=Built-in+integrations\u0026amp;title=get_integration_state\u0026amp;description=**Get+integration+state**%0A%0ARead+workspace+connections%2C+provider+authorization%2C+import+fields%2C+and+initial+import+progress.+Pass+query%3A+%7Bkind%3A+workspace%7D+to+conf\u0026amp;theme=cc7de14802162a79d7966e1d\u0026amp;signature=297a3637cc8260607c1033653889551d3dce637d50f7f03d5bcaf90d94c72d78\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/rippit-ddefb232/u1OvlVJ9fpltsljb/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Rippit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#079669\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.rippit.com/api-reference/get_integration_state\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/get_integration_state.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.rippit.com/#organization\",\"name\":\"Rippit\",\"url\":\"https://docs.rippit.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/rippit-ddefb232/uzkTtzpXlUcSK32Q/logo/light.svg?fit=max\u0026auto=format\u0026n=uzkTtzpXlUcSK32Q\u0026q=85\u0026s=8950a1dcb68093d7ac8370f0f847f209\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.rippit.com#website\",\"name\":\"Rippit\",\"url\":\"https://docs.rippit.com\",\"publisher\":{\"@id\":\"https://docs.rippit.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.rippit.com/api-reference/get_integration_state#webpage\",\"url\":\"https://docs.rippit.com/api-reference/get_integration_state\",\"name\":\"get_integration_state\",\"description\":\"Get integration state Read workspace connections, provider authorization, import fields, and initial import progress. Pass query: {kind: workspace} to confirm the destination workspace, signed-in email, supported providers, and current connections. Pass {kind: request, request_id} for an authorization request, or {kind: connection, source, account_id, etl_id} for import status; add fields: true inside the connection query to inspect optional import fields. For Salesforce, use {kind: objects, source: salesforce, account_id, etl_id} instead of fields: true to list available objects. Results are returned in the setup object. status.workspaceTableId is the readable Rippit table id; pass it as workspace_table_id to describe_table, read_table, or aggregate_table. status.tableId is an internal id and must not be passed to those tools. If workspaceTableId is absent, discover the table before reading it. Salesforce status.tables lists each selected object, its progress, and its workspaceTableId. Use those readable ids for table tools. The overall state stays importing until all selected tables finish; do not infer completion from Cases alone. objects[].doFullRepull means that object imports all history regardless of history_days. Authorization request status completed means authorized, not imported. A ready initial import does not guarantee complete history; match the connection's ETL id to the resulting table and check coverage before analysis. Report status.warning and do not retry a ready import. Use connect_integration for authorization. Use import_integration to start or retry an import.\",\"dateModified\":\"2026-11-09T01:29:32.244Z\",\"isPartOf\":{\"@id\":\"https://docs.rippit.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.rippit.com/api-reference/get_integration_state#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.rippit.com/api-reference/get_integration_state#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Connect data\",\"item\":\"https://docs.rippit.com/api-reference/connect/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Built-in integrations\",\"item\":\"https://docs.rippit.com/api-reference/connect/integrations/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"get_integration_state\",\"item\":\"https://docs.rippit.com/api-reference/get_integration_state\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.rippit.com/api-reference/get_integration_state#apireference\",\"headline\":\"get_integration_state\",\"name\":\"get_integration_state\",\"description\":\"Get integration state Read workspace connections, provider authorization, import fields, and initial import progress. Pass query: {kind: workspace} to confirm the destination workspace, signed-in email, supported providers, and current connections. Pass {kind: request, request_id} for an authorization request, or {kind: connection, source, account_id, etl_id} for import status; add fields: true inside the connection query to inspect optional import fields. For Salesforce, use {kind: objects, source: salesforce, account_id, etl_id} instead of fields: true to list available objects. Results are returned in the setup object. status.workspaceTableId is the readable Rippit table id; pass it as workspace_table_id to describe_table, read_table, or aggregate_table. status.tableId is an internal id and must not be passed to those tools. If workspaceTableId is absent, discover the table before reading it. Salesforce status.tables lists each selected object, its progress, and its workspaceTableId. Use those readable ids for table tools. The overall state stays importing until all selected tables finish; do not infer completion from Cases alone. objects[].doFullRepull means that object imports all history regardless of history_days. Authorization request status completed means authorized, not imported. A ready initial import does not guarantee complete history; match the connection's ETL id to the resulting table and check coverage before analysis. Report status.warning and do not retry a ready import. Use connect_integration for authorization. Use import_integration to start or retry an import.\",\"url\":\"https://docs.rippit.com/api-reference/get_integration_state\",\"mainEntityOfPage\":{\"@id\":\"https://docs.rippit.com/api-reference/get_integration_state#webpage\"},\"dateModified\":\"2026-11-09T01:29:32.244Z\",\"publisher\":{\"@id\":\"https://docs.rippit.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.rippit.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Rippit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Rippit","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/overview"}]},{"tab":"API reference","groups":[{"group":"Get started","pages":[{"title":"API overview","sidebarTitle":"Overview","href":"/api-reference/overview"},{"title":"Authentication","href":"/api-reference/authentication"}]},{"group":"Connect data","pages":[{"title":"Connect data","sidebarTitle":"Overview","href":"/api-reference/connect/overview"},{"group":"Built-in integrations","pages":[{"title":"Built-in integrations","sidebarTitle":"Overview","description":"Connect Zendesk, Intercom, Slack or Gong and import their conversations into Rippit.","href":"/api-reference/connect/integrations/overview"},{"title":"get_integration_state","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/get_integration_state","href":"/api-reference/get_integration_state"},{"title":"connect_integration","description":"**Connect integration**\n\nCreate a requester-only authorization link for Zendesk, Intercom, Slack ingestion, Gong, or Salesforce. Use only after the user requests the connection; get_integration_state confirms the destination workspace and supported providers. Reuse an already authenticated connection when it is the one the user wants. For Gong, the user enters the access key, access secret, and subdomain in the browser form.\n\nFor Salesforce, confirm Service Cloud, Sales Cloud, or both and whether this is a sandbox. Pass serviceCloud and salesCloud explicitly; isSandbox true uses sandbox login. Salesforce is available only for enabled PLG or hybrid workspaces. Authorization does not select which objects to import.\n\nClients supporting URL elicitation display an authorization prompt outside the model conversation. After the user continues, this call verifies the same stored request. If authorizationMode is url_elicitation, do not claim that no prompt appeared because it is absent from the transcript. Otherwise, show authorizationUrl and ask the user to open it. They must sign into the same Rippit account, review the destination workspace, and authorize the provider in the browser. Never ask for passwords, API keys, access tokens, or authorization codes in chat. This authorizes data access only; importing is a separate step. For Slack, the bot can read only channels it has access to; ask the user to add it to the channels they want imported.\n\nRetain request.id. After the 30-minute native prompt window expires, the transport returns url_elicitation_expired and the original requestId; if the client does not resume, tell the user to return and say Done, then check that exact request with get_integration_state rather than creating another. Do not create another link while one is pending unless the user requests a replacement.","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/connect_integration","href":"/api-reference/connect_integration"},{"title":"import_integration","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/import_integration","href":"/api-reference/import_integration"},{"title":"list_active_integrations","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/list_active_integrations","href":"/api-reference/list_active_integrations"}]},{"group":"Snowflake","pages":[{"title":"Snowflake","sidebarTitle":"Overview","href":"/api-reference/connect/snowflake/overview"},{"title":"list_snowflake_connections","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/list_snowflake_connections","href":"/api-reference/list_snowflake_connections"},{"title":"manage_snowflake_connection","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/manage_snowflake_connection","href":"/api-reference/manage_snowflake_connection"},{"title":"list_snowflake_tables","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/list_snowflake_tables","href":"/api-reference/list_snowflake_tables"},{"title":"describe_snowflake_table","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/describe_snowflake_table","href":"/api-reference/describe_snowflake_table"},{"title":"manage_snowflake_import","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/manage_snowflake_import","href":"/api-reference/manage_snowflake_import"},{"title":"list_snowflake_imports","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/list_snowflake_imports","href":"/api-reference/list_snowflake_imports"}]},{"group":"Bulk API","pages":[{"title":"Bulk API","sidebarTitle":"Overview","href":"/api-reference/connect/bulk/overview"},{"title":"Conversations","href":"/api-reference/connect/bulk/conversations"},{"title":"Tables","href":"/api-reference/connect/bulk/tables"},{"title":"Bulk export","sidebarTitle":"Export","href":"/api-reference/connect/bulk/export"},{"title":"Bulk API skill","sidebarTitle":"Skill","href":"/api-reference/connect/bulk/rippit-bulk-ingest-api"},{"title":"Post Conversation Source","deprecated":null,"version":null,"openapi":"/api-reference/bulk-openapi.json post /bulk_ingest/conversation_sources","href":"/api-reference/bulk_ingest/post-conversation-source"},{"title":"Get Conversation Sources","deprecated":null,"version":null,"openapi":"/api-reference/bulk-openapi.json get /bulk_ingest/conversation_sources","href":"/api-reference/bulk_ingest/get-conversation-sources"},{"title":"Post Conversation Blocks Bulk","deprecated":null,"version":null,"openapi":"/api-reference/bulk-openapi.json post /bulk_ingest/conversation_blocks/bulk","href":"/api-reference/bulk_ingest/post-conversation-blocks-bulk"},{"title":"Post Dataset","deprecated":null,"version":null,"openapi":"/api-reference/bulk-openapi.json post /bulk_ingest/datasets","href":"/api-reference/bulk_ingest/post-dataset"},{"title":"Patch Dataset By Query","deprecated":null,"version":null,"openapi":"/api-reference/bulk-openapi.json patch /bulk_ingest/datasets","href":"/api-reference/bulk_ingest/patch-dataset-by-query"},{"title":"Post Dataset Bulk By Query","deprecated":null,"version":null,"openapi":"/api-reference/bulk-openapi.json post /bulk_ingest/datasets/bulk","href":"/api-reference/bulk_ingest/post-dataset-bulk-by-query"},{"title":"Post Job Start","deprecated":null,"version":null,"openapi":"/api-reference/bulk-openapi.json post /bulk_ingest/jobs/{job_id}/start","href":"/api-reference/bulk_ingest/post-job-start"},{"title":"Get Job","deprecated":null,"version":null,"openapi":"/api-reference/bulk-openapi.json get /bulk/jobs/{job_id}","href":"/api-reference/bulk/get-job"},{"title":"Create Export Job","deprecated":null,"version":null,"openapi":"/api-reference/bulk-openapi.json post /bulk_export/tables","href":"/api-reference/bulk_export/create-export-job"}]}]},{"group":"Analyze data","pages":[{"group":"Query data","pages":[{"title":"Query data","sidebarTitle":"Overview","href":"/api-reference/query/overview"},{"title":"list_data_sources","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/list_data_sources","href":"/api-reference/list_data_sources"},{"title":"describe_table","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/describe_table","href":"/api-reference/describe_table"},{"title":"describe_column","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/describe_column","href":"/api-reference/describe_column"},{"title":"read_table","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/read_table","href":"/api-reference/read_table"},{"title":"aggregate_table","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/aggregate_table","href":"/api-reference/aggregate_table"},{"title":"pivot_table","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/pivot_table","href":"/api-reference/pivot_table"},{"title":"read_conversations","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/read_conversations","href":"/api-reference/read_conversations"}]},{"group":"Worksheets","pages":[{"title":"Worksheets","sidebarTitle":"Overview","href":"/api-reference/worksheets/overview"},{"title":"list_worksheets","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/list_worksheets","href":"/api-reference/list_worksheets"},{"title":"create_worksheet","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/create_worksheet","href":"/api-reference/create_worksheet"},{"title":"enrich_worksheet","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/enrich_worksheet","href":"/api-reference/enrich_worksheet"},{"title":"get_enrich_status","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/get_enrich_status","href":"/api-reference/get_enrich_status"},{"title":"export_worksheet","deprecated":null,"version":null,"playground":"none","openapi":"/api-reference/tools-openapi.json post /v1/export_worksheet","href":"/api-reference/export_worksheet"}]}]},{"group":"AI pipelines","pages":[{"title":"AI pipelines","sidebarTitle":"Overview","href":"/api-reference/pipelines/overview"}]}]}]},"basePath":"","title":"get_integration_state - Rippit","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}