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

# List Connections

> List available Connections

## Query Parameters

<ParamField query="key" type="string">
  A comma separated list of connection keys
</ParamField>

<ParamField query="platformVersion" type="string">
  The platform version
</ParamField>

<ParamField query="name" type="string">
  The connection name
</ParamField>

<ParamField query="identityType" type="&#x22;user&#x22; | &#x22;team&#x22; | &#x22;organization&#x22; | &#x22;project&#x22;">
  The identity type
</ParamField>

<ParamField query="identity" type="string">
  The connection identifier
</ParamField>

<ParamField query="platform" type="string">
  The connector platform (e.g. stripe, exa)
</ParamField>

<ParamField query="tags" type="string">
  A comma separated list of tags
</ParamField>

<ParamField query="active" type="boolean" default="true">
  Filter connections by active status
</ParamField>

<ParamField query="limit" type="number" default="20">
  The number of connections to return
</ParamField>

<ParamField query="page" type="number" default="1">
  The page number
</ParamField>

## Response

<ResponseField name="rows" type="Connection[]">
  Array of Connection objects

  <Expandable title="Connection properties">
    <ResponseField name="id" type="string">
      The unique identifier for the connection
    </ResponseField>

    <ResponseField name="platformVersion" type="string">
      The version of the platform connector
    </ResponseField>

    <ResponseField name="name" type="string | null">
      The display name of the connection
    </ResponseField>

    <ResponseField name="type" type="'api'">
      The connection type
    </ResponseField>

    <ResponseField name="key" type="string">
      The unique connection key
    </ResponseField>

    <ResponseField name="environment" type="'test' | 'live'">
      The connection environment
    </ResponseField>

    <ResponseField name="platform" type="string">
      The platform identifier (e.g. `resend`, `stripe`)
    </ResponseField>

    <ResponseField name="identity" type="string">
      The user or entity identifier associated with this connection
    </ResponseField>

    <ResponseField name="identityType" type="'user' | 'team' | 'organization' | 'project'">
      The type of identity
    </ResponseField>

    <ResponseField name="description" type="string">
      A description of the platform
    </ResponseField>

    <ResponseField name="state" type="'operational' | 'degraded' | 'failed' | 'unknown'">
      The current state of the connection

      * `operational` - Connection is healthy and working correctly
      * `degraded` - OAuth token refresh failed, automatic retry pending
      * `failed` - Connection is inactive and requires manual reconnection
      * `unknown` - State could not be determined
    </ResponseField>

    <ResponseField name="tags" type="string[]">
      Array of tags associated with the connection
    </ResponseField>

    <ResponseField name="version" type="string">
      The connection version
    </ResponseField>

    <ResponseField name="active" type="boolean">
      Whether the connection is active
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      ISO 8601 timestamp of when the connection was created
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="total" type="number">
  Total number of connections matching the query
</ResponseField>

<ResponseField name="pages" type="number">
  Total number of pages available
</ResponseField>

<ResponseField name="page" type="number">
  Current page number
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl 'https://api.picaos.com/v1/vault/connections' \
    -H 'x-pica-secret: YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "rows": [
      {
        "id": "673f79c6-0110-408b-bcbe-f4da000e66c7",
        "platformVersion": "1.0.0",
        "name": null,
        "type": "api",
        "key": "test::resend::default::46f75762f34e4962bf5684760f0f9f0e",
        "environment": "test",
        "platform": "resend",
        "identity": "46f75762f34e4962bf5684760f0f9f0e",
        "identityType": "user",
        "description": "Email API for developers",
        "state": "operational",
        "tags": [],
        "version": "1.0.0",
        "active": true,
        "createdAt": "2025-07-19T16:19:29.702632Z"
      },
      ...
    ],
    "total": 20,
    "pages": 2,
    "page": 1
  }
  ```
</ResponseExample>