---
title: "List connections"
method: GET
path: "/v1/workspaces/{workspace_id}/connections"
tags: ["Connections"]
---

# List connections

`GET /v1/workspaces/{workspace_id}/connections`

## Request

- Base URL: `https://api.stacksync.com`
- URL: `https://api.stacksync.com/v1/workspaces/{workspace_id}/connections`
- Auth: HTTP bearer

The connections of the workspace in one region that the caller can see: the ones they created and the ones shared with the workspace.

## Path parameters

- `workspace_id` integer, required

## Query parameters

- `region` 'besg' | 'usnv', required: Region of the connection: besg or usnv
- `name` string, nullable: Only the connection with exactly this name
- `connection_name` string, nullable: Same as name
- `search` string, nullable: Only connections whose name contains this text, case-insensitive
- `app_type` string, nullable: Only connections of this app type: the type shown in Stacksync (app_type) or the underlying connector type, case-insensitive

## Response `200`

OK

- ConnectionListResponse
  - `data` Connection[], required
    - `connection_id` string, required
    - `connection_name` string, required
    - `app_type` string, required: The type shown in Stacksync
    - `is_shared_with_workspace` boolean, required
    - `created_time` string, required: UTC, YYYY-MM-DD HH:MM:SS
    - `last_modified_time` string, required: UTC, YYYY-MM-DD HH:MM:SS
    - `credentials_options` object, required: The identifiers of the connection (instance_id, instance_url, shop_name, sub_domain...), never a secret
    - `connection_resource_id` string, nullable, required: The name workflow steps reference the connection by
    - `region` string, required
    - `needs_reauthorization` boolean, required: True when Stacksync marked the credentials invalid (the app refused to refresh them): reauthorize it in Stacksync. Credentials the app refuses on a read are reported by that read

## Other responses

- `400`: Bad Request
- `403`: Forbidden

---

[API](https://skmtc.dev/stacksync/apis/stacksync-api.md) - [All operations](https://skmtc.dev/stacksync/apis/stacksync-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stacksync/apis/stacksync-api/revisions/21f4ba4b214e?raw)