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

# Read provider setup outcome

> Requires a verified personal Firebase/MCP credential and current provider configuration authority. Team API/OAuth keys cannot impersonate their creator. Test import mode does not isolate real provider accounts; read effect_scope and disclosures. Returns current status and allowlisted result, never stored secrets or OAuth state. completed confirms this attempt; pending/awaiting_oauth/outcome_unknown do not. result.connected false never proves a previous connection is disconnected.



## OpenAPI

````yaml openapi.json GET /teams/{id}/integration-connection-sessions/{sessionId}
openapi: 3.0.3
info:
  title: gigstack API v2
  description: >
    # gigstack API v2


    Build customer, invoice and payment integrations. Start with the
    [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing
    country](https://docs.gigstack.io/concepts/shared-fields).


    ## Authentication and environments


    Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use
    https://api.gigstack.io/v2. Internal staging uses
    https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test
    mode is a data mode within an environment; a body field does not switch a
    key's mode.


    See [authentication](https://docs.gigstack.io/authentication) for key
    handling, OAuth team scope and gigstack Connect. Internal partner
    provisioning is outside this public contract; health probes have their own
    security declarations. Operations marked unavailable have no configured
    public gateway route.


    ## Read the operation contract


    Response envelopes, pagination and retry rules differ by endpoint. HTTP
    success alone does not prove external fiscal completion or movement of
    money. Reconcile ambiguous writes before retrying. Use [responses and
    recovery](https://docs.gigstack.io/responses) and the operation's error
    codes; document credits and daily limits are not generic retryable rate
    limits.


    The issuing team's configuration selects Mexico or Colombia; customer
    country and currency do not. Read
    [Mexico](https://docs.gigstack.io/countries/mexico) or
    [Colombia](https://docs.gigstack.io/countries/colombia) before choosing
    fiscal fields. Accepted public input differs from a provider's direct
    payload.


    Examples and schema checks do not imply every operation has been executed
    live. [Verification coverage](https://docs.gigstack.io/verification)
    distinguishes source review, offline checks and observed staging behavior.
    Documentation describes operations and does not authorize execution.
  version: 2.0.0
  contact:
    name: Gigstack API Support
    url: https://gigstack.io
    email: support@gigstack.io
  license:
    name: Proprietary
    url: https://gigstack.io/terms
  termsOfService: https://gigstack.io/terms
servers:
  - url: https://api.gigstack.io/v2
    description: >
      Public API for standard live and test-mode keys. Test data is isolated by
      the key mode

      (`livemode: false`). Internal staging is a separate deployment and key
      store; see

      https://docs.gigstack.io/authentication#environments for its base URL.
security:
  - bearerAuth: []
externalDocs:
  description: Complete API Documentation & Guides
  url: https://docs.gigstack.io
paths:
  /teams/{id}/integration-connection-sessions/{sessionId}:
    get:
      tags:
        - Provider Setup
      summary: Read provider setup outcome
      description: >-
        Requires a verified personal Firebase/MCP credential and current
        provider configuration authority. Team API/OAuth keys cannot impersonate
        their creator. Test import mode does not isolate real provider accounts;
        read effect_scope and disclosures. Returns current status and
        allowlisted result, never stored secrets or OAuth state. completed
        confirms this attempt; pending/awaiting_oauth/outcome_unknown do not.
        result.connected false never proves a previous connection is
        disconnected.
      operationId: integrationSetupGet
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Setup session state, not a generic connection-success assertion.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/IntegrationSetupSession'
                  timestamp:
                    type: number
                required:
                  - success
                  - data
                  - timestamp
        '400':
          description: Invalid body, unsupported provider or missing explicit consent.
        '401':
          description: Verified personal credential required.
        '403':
          description: >-
            Current provider configuration authority, entitlement or browser
            identity required.
        '404':
          description: Team or session inaccessible.
        '409':
          description: >-
            Setup locked, session changed, cannot cancel or recovery not yet
            available.
        '503':
          description: >-
            Explicit runtime environment or matching browser origin not
            configured.
      security:
        - bearerAuth: []
components:
  schemas:
    IntegrationSetupSession:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
        team_id:
          type: string
        team:
          type: object
          additionalProperties: false
          properties:
            id:
              type: string
            name:
              type: string
              nullable: true
          required:
            - id
            - name
        provider:
          type: string
          enum:
            - airtable
            - mercadolibre
            - netsuite
            - zettle
        method:
          type: string
          enum:
            - oauth
            - credentials
        credential_livemode:
          type: boolean
        effect_scope:
          type: string
          enum:
            - team_shared_credentials
            - credential_mode
            - connection_import_mode
        status:
          type: string
          enum:
            - pending
            - processing
            - awaiting_oauth
            - completed
            - failed
            - outcome_unknown
            - cancelled
            - expired
        created_at:
          type: number
        expires_at:
          type: number
        updated_at:
          type: number
        completion_url:
          type: string
        can_submit:
          type: boolean
        recovery_available_at:
          type: number
          nullable: true
        disclosures:
          type: array
          items:
            type: string
        credential_schema:
          type: object
          additionalProperties: true
          description: >-
            Exact public browser form schema; contains no stored credential
            values.
        result:
          type: object
          additionalProperties: false
          properties:
            connected:
              type: boolean
            credentials_may_be_stored:
              type: boolean
          required:
            - connected
            - credentials_may_be_stored
          nullable: true
        error:
          type: object
          additionalProperties: false
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          nullable: true
        resolution:
          type: object
          additionalProperties: false
          properties:
            action:
              type: string
              enum:
                - released_for_new_session
            resolved_at:
              type: number
          required:
            - action
            - resolved_at
          nullable: true
        recovery:
          type: object
          additionalProperties: false
          properties:
            operation_id:
              type: string
            action:
              type: string
              enum:
                - register
                - unregister
                - disconnect
            original_status:
              type: string
              enum:
                - outcome_unknown
            effect_scope:
              type: string
              enum:
                - shared_connection
            livemode:
              type: boolean
            local_disabled_count:
              type: integer
              minimum: 0
            snapshot_complete:
              type: boolean
            identity_verification:
              type: string
              enum:
                - pending
                - same
                - different
                - unverified
            imports_disabled:
              type: boolean
              enum:
                - true
            prior_outcome_preserved:
              type: boolean
              enum:
                - true
          required:
            - operation_id
            - action
            - original_status
            - effect_scope
            - livemode
            - local_disabled_count
            - snapshot_complete
            - identity_verification
            - imports_disabled
            - prior_outcome_preserved
          nullable: true
      required:
        - id
        - team_id
        - team
        - provider
        - method
        - credential_livemode
        - effect_scope
        - status
        - created_at
        - expires_at
        - updated_at
        - completion_url
        - can_submit
        - recovery_available_at
        - disclosures
        - credential_schema
        - result
        - error
        - resolution
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        **Authentication Method:** HTTP Bearer token.


        The runtime requires the literal `Bearer ` prefix — a bare token in the

        `Authorization` header is rejected with `401 unauthorized`.


        **Header Format:** `Authorization: Bearer YOUR_API_KEY`


        Your API key is a JWT. Live keys operate on live data (`livemode:
        true`);

        test keys operate on isolated test data (`livemode: false`).


        **Get your key at:**
        [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)


        **Errors:** credential failures are answered by the authentication layer
        with a raw

        `{ "message": … }` body, not the standardized envelope — `401` for a
        missing, malformed or

        expired token, `403` for a revoked key or a plan without API access. See
        the `Unauthorized`

        and `AuthForbidden` responses.

````

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