See Stacksync in action with a solution architect. Book a demo ↗
StacksyncDocs
StacksyncCommunityBook a demoContact Support
HomeTwo-way syncAgentic WorkflowsGeniesEnterprise OSMCPEDIConnectorsSecurity and Other ResourcesChangelogDevelopersAPI Reference
Connections

Connections

Get a connection

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

One connection, with every sync, workflow, API proxy and scheduled task that uses it and whether it can be deleted. Never its credentials.

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.

connection_id*string

The connection.

Formatuuid

Query Parameters

region*Region

Region of the connection: besg or usnv

Value in"besg""usnv"

Response Body

OK

application/json
  1. response
data*
Get a connection
curl -X GET 'https://api.stacksync.com/v1/workspaces/0/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08?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,    "used_in_syncs": [      {        "sync_id": "<sync_id>",        "sync_name": "<sync_name>"      }    ],    "used_in_workflows": [      {        "workflow_id": "<workflow_id>",        "workflow_name": "<workflow_name>"      }    ],    "used_in_api_proxies": [      {        "api_proxy_id": "<api_proxy_id>",        "api_proxy_name": "<api_proxy_name>"      }    ],    "used_in_tasks": [      {        "task_id": "<task_id>",        "task_name": "<task_name>",        "sync_id": "<sync_id>",        "trigger_id": "<trigger_id>"      }    ],    "can_delete": false  }}

GETList 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.

POSTCreate a connection

Create a connection to an app with the credentials given, after testing them against the app. Only the user of the API key can use the connection unless `is_shared_with_workspace` is true. Answers the connection without its secrets.