> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rippit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# get_integration_state

> **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.



## OpenAPI

````yaml /api-reference/tools-openapi.json post /v1/get_integration_state
openapi: 3.1.0
info:
  title: Rippit API
  version: 1.0.0
  description: Every operation is also an MCP tool with the same name and parameters.
servers:
  - url: https://api.rippit.com
security:
  - bearer: []
paths:
  /v1/get_integration_state:
    post:
      summary: 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.
      operationId: get_integration_state
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                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
                query:
                  oneOf:
                    - type: object
                      properties:
                        kind:
                          type: string
                          const: workspace
                      required:
                        - kind
                      additionalProperties: false
                    - type: object
                      properties:
                        kind:
                          type: string
                          const: request
                        request_id:
                          type: string
                          minLength: 1
                          maxLength: 255
                      required:
                        - kind
                        - request_id
                      additionalProperties: false
                    - type: object
                      properties:
                        kind:
                          type: string
                          const: objects
                        source:
                          type: string
                          const: salesforce
                        account_id:
                          type: string
                          minLength: 1
                          maxLength: 255
                          description: >-
                            Exact provider account id returned by
                            get_integration_state.
                        etl_id:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 9007199254740991
                          description: ETL id of that same connection.
                      required:
                        - kind
                        - source
                        - account_id
                        - etl_id
                      additionalProperties: false
                    - type: object
                      properties:
                        kind:
                          type: string
                          const: connection
                        source:
                          type: string
                          enum:
                            - zendesk
                            - intercom
                            - slack_ingest
                            - gong
                            - salesforce
                          description: Provider returned by get_integration_state.
                        account_id:
                          type: string
                          minLength: 1
                          maxLength: 255
                          description: >-
                            Exact provider account id returned by
                            get_integration_state.
                        etl_id:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 9007199254740991
                          description: ETL id of that same connection.
                        fields:
                          description: >-
                            Read available import fields instead of import
                            progress.
                          type: boolean
                      required:
                        - kind
                        - source
                        - account_id
                        - etl_id
                      additionalProperties: false
                  description: >-
                    Inspect the workspace, an authorization attempt, a connected
                    provider, or available Salesforce import objects.
              required:
                - query
              additionalProperties: false
      responses:
        '200':
          description: Tool result.
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.