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

# List Integration Connections

> List the workspace's own tax, CRM, and storage integration connections, secret-free, plus whether the credential vault is ready.

Returns the workspace's active bring-your-own integration connections: tax
(`taxjar`, `avalara`, `ziptax`), CRM (`hubspot`), and storage (`s3`). At most
one connection per category is active at a time — connecting a provider
deactivates any other active provider in the same category — so the list has
at most three entries, ordered by category then provider. Secrets are
write-only — each connection carries only its non-secret config (region,
bucket, endpoints) and a `has_secrets` flag saying whether a secret is stored.
`vault_ready` tells you whether [Connect an Integration](/api-reference/integration-connections/create)
can succeed at all; when it is `false` the stored blobs cannot be opened
either, so every entry comes back with `config: {}` and `has_secrets: false`
regardless of what was stored. Payment gateways are a separate resource — see
[List Gateway Connections](/api-reference/gateways/list).

## Example Request

```bash theme={null}
curl "https://api.recurso.dev/v1/integration-connections" \
  -H "Authorization: Bearer $API_KEY"
```

## Response

```json theme={null}
{
  "data": {
    "connections": [
      {
        "id": "c7d8e9f0-1a2b-4c3d-9e4f-5a6b7c8d9e0f",
        "category": "storage",
        "provider": "s3",
        "config": {
          "bucket": "acme-invoices",
          "region": "ap-south-1"
        },
        "has_secrets": true,
        "created_at": "2026-08-30T08:11:44Z",
        "updated_at": "2026-08-30T08:11:44Z"
      },
      {
        "id": "9b1c2d3e-4f5a-4b6c-8d7e-0f1a2b3c4d5e",
        "category": "tax",
        "provider": "taxjar",
        "config": {},
        "has_secrets": true,
        "created_at": "2026-08-12T09:30:00Z",
        "updated_at": "2026-08-12T09:30:00Z"
      }
    ],
    "vault_ready": true
  }
}
```

## Fields

| Field                       | Type               | Description                                                                                                                                                         |
| --------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `connections`               | array              | Active connections, at most one per `category`                                                                                                                      |
| `connections[].id`          | string (uuid)      | The connection's id; changes on every connect, including a credential rotation for the same provider                                                                |
| `connections[].category`    | string             | `tax`, `crm`, or `storage`                                                                                                                                          |
| `connections[].provider`    | string             | `taxjar`, `avalara`, `ziptax`, `hubspot`, or `s3`                                                                                                                   |
| `connections[].config`      | object             | Non-secret config only (`api_url`, `base_url`, `endpoint`, `region`, `bucket`, `prefix`, `company_code`); every other key is treated as a secret and never returned |
| `connections[].has_secrets` | boolean            | `true` when at least one secret value is stored for the connection; always `false` while `vault_ready` is `false`, because the sealed config cannot be opened       |
| `connections[].created_at`  | string (date-time) | When this connection row was created — a reconnect inserts a new row rather than updating the old one                                                               |
| `connections[].updated_at`  | string (date-time) | Equal to `created_at` for every listed (active) connection; it only moves when a row is deactivated, and deactivated rows are not listed                            |
| `vault_ready`               | boolean            | `false` when `GATEWAY_ENCRYPTION_KEY` is unset on the API — connecting will fail with `503`, and listed connections show `config: {}` and `has_secrets: false`      |

## Errors

| Status | Code             | When                                 | Fix                                   |
| ------ | ---------------- | ------------------------------------ | ------------------------------------- |
| `401`  | `unauthorized`   | Missing or invalid API key / session | Send `Authorization: Bearer $API_KEY` |
| `500`  | `internal_error` | Unexpected server failure            | Retry; contact support if it persists |

Errors use the standard envelope — see [Errors](/api-reference/errors).


## OpenAPI

````yaml GET /v1/integration-connections
openapi: 3.1.0
info:
  title: Recurso API
  version: 1.0.0
  description: |
    The Recurso billing engine REST API.

    Authenticate by passing your API key as a bearer token:

        Authorization: Bearer <api_key>

    Obtain an API key by registering a tenant via `POST /auth/register`.
    All authenticated endpoints live under the `/v1` prefix. Mutating
    endpoints support idempotency via the `Idempotency-Key` header.
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://billing.example.com
    description: >-
      Example deployment — substitute the base URL of your own Recurso
      deployment.
security:
  - bearerAuth: []
tags:
  - name: System
    description: Health, version, and API metadata
  - name: Auth
    description: Tenant registration
  - name: Plans
    description: Product catalog plans
  - name: Customers
    description: Customer management
  - name: Subscriptions
    description: Subscription lifecycle
  - name: Invoices
    description: Invoices, PDFs, and Indian GST e-invoicing
  - name: Coupons
    description: Discounts
  - name: Usage
    description: Metered usage events
  - name: Credit Notes
    description: Customer credits
  - name: Quotes
    description: Quote-to-invoice lifecycle
  - name: Webhooks
    description: Webhook endpoint management and event feed
  - name: Analytics
    description: Revenue analytics
  - name: Checkout
    description: Public hosted checkout for invoices
  - name: Payments
    description: Payment order creation
  - name: Inbound Webhooks
    description: Receivers for payment-gateway callbacks (Razorpay, Stripe)
  - name: Customer Portal
    description: Customer-facing portal — magic-link auth and session-scoped data
  - name: Developer
    description: API key management
  - name: Account
    description: Tenant account settings
  - name: Finance
    description: Ledger accounts, entries, reconciliation, and revenue recognition
  - name: Settings
    description: Tax (GST) and e-invoicing (IRP) configuration
  - name: Consents
    description: Consent records for RBI-compliant recurring billing
  - name: Referrals
    description: Customer referral program
  - name: Gifts
    description: Gift subscriptions
  - name: Mandates
    description: UPI Autopay mandates
  - name: Offline Payments
    description: Virtual accounts and manually recorded payments
  - name: Organizations
    description: Multi-entity organizations grouping several tenants
  - name: Accounting
    description: QuickBooks / Xero accounting integrations
  - name: Churn
    description: Churn risk scoring and alerts
  - name: Cancel Flows
    description: Configurable retention flows shown at cancellation time
  - name: Dunning
    description: Dunning analytics and multi-channel dunning campaigns
paths:
  /v1/integration-connections:
    get:
      tags:
        - Integration Connections
      summary: List the tenant's BYO tax/CRM/storage integrations
      description: >
        Returns the tenant's active tax (TaxJar/Avalara), CRM (HubSpot), and

        storage (S3/MinIO) connections — secret-free (only non-secret config
        like

        region/bucket, and whether secrets are set) — plus vault availability.
      operationId: listIntegrationConnections
      responses:
        '200':
          description: Connections and vault status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      connections:
                        type: array
                        items:
                          $ref: '#/components/schemas/IntegrationConnectionView'
                      vault_ready:
                        type: boolean
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    IntegrationConnectionView:
      type: object
      description: Secret-free projection of a BYO tax/CRM/storage connection.
      properties:
        id:
          type: string
          format: uuid
        category:
          type: string
          enum:
            - tax
            - crm
            - storage
        provider:
          type: string
        config:
          type: object
          additionalProperties:
            type: string
          description: Non-secret config fields only (e.g. region, bucket, endpoints).
        has_secrets:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          description: Structured error detail.
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine-readable error code.
              examples:
                - validation_failed
                - unauthorized
                - forbidden
                - not_found
                - conflict
                - rate_limited
                - internal_error
                - invalid_api_key
                - key_mode_mismatch
                - over_refund
                - invoice_not_paid
                - invoice_already_paid
            message:
              type: string
              description: Human-readable explanation.
  responses:
    Unauthorized:
      description: Missing or invalid credentials (API key or session cookie).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Tenant API key obtained from `POST /auth/register` or `POST
        /v1/developer/keys`.

````