See Stacksync in action with a solution architect. Book a demo ↗
Connections

Connections

List connections

GET
/v1/workspaces/{workspace_id}/connections

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

Authorization

Authorizationstringheaderrequired

Bearer <key>, where <key> is a workspace API key or a user API key. See Authentication.

Path Parameters

workspace_id*integer

The workspace. List the ones your key can reach with GET /v1/workspaces.

Query Parameters

region*Region

Region of the connection: besg or usnv

Value in"besg""usnv"
name?|

Only the connection with exactly this name

Defaultnull
connection_name?|

Same as name

Defaultnull
search?|

Only connections whose name contains this text, case-insensitive

Defaultnull
app_type?|

Only connections of this app type: the type shown in Stacksync (app_type) or the underlying connector type, case-insensitive

Defaultnull

Response Body

OK

application/json
  1. response
data*array<>
List connections
curl -X GET 'https://api.stacksync.com/v1/workspaces/0/connections?region=usnv'
{  "data": [    {      "connection_id": "<connection_id>",      "connection_name": "<connection_name>",      "app_type": "<app_type>",      "is_shared_with_workspace": false,      "created_time": "<created_time>",      "last_modified_time": "<last_modified_time>",      "credentials_options": {},      "connection_resource_id": "<connection_resource_id>",      "region": "<region>",      "needs_reauthorization": false    }  ]}