---
title: "Filter & list connections"
method: GET
path: "/token/connections"
tags: ["Vault Proxy Connections"]
---

# Filter & list connections

`GET /token/connections`

Fetch list of connections for given query parameters.
By default, deleted connections are excluded from the results.

## Query parameters

- `filter[connectionType]` 'inbound' | 'outbound'
- `filter[live]` boolean
- `filter[searchTerm]` string
- `filter[includeDeleted]` boolean

## Response `200`

Success.

- object
  - `paging` object — Paging information about the results.
    - `next` string
  - `results` object[] — List of results for the query.
    - `name` string, required — Name of the connection.
    - `description` string — Description of the connection.
    - `connectionType` 'inbound' | 'outbound', required — Defines the category of the connection. Once a connection is created, this value is fixed and cannot be modified. You can find more information about types of connections [in guide](https://docs.payrails.com/docs/proxy-connections).
    - `id` string — Internal facing connection identifier.
    - `liveVersionId` string, nullable — Each connection has multiple versions (`connectionVersions`) that include configurations. At any given time, only one version can be live for a connection. This field specifically stores the version that is live for a particular connection. If `liveVersionId` is set to `null` it means connection is not live.
    - `workspaceId` string — ID of the workspace to which the connection belongs.
    - `updatedAt` string, date-time — Date and time when the connection was last updated.
    - `createdAt` string, date-time — Date and time when the connection was created.
    - `deletedAt` string, date-time, nullable — Date and time when the connection was deleted. Null if the connection is not deleted.

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.
- `403` — Insufficient Scope.

---

[API](https://skmtc.net/payrails/apis/payrails-api-reference.md) · [All operations](https://skmtc.net/payrails/apis/payrails-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payrails/payrails-api-reference/versions/9dd2f0158582/schema)