Connections API

List and manage authenticated connections to external services.

List Connections

Retrieve all connections in your project.

GET /api/v1/connections

Query Parameters:

Parameter	Type	Description
limit	integer	Max results per page (default: 10, max: 100)
cursor	string	Pagination cursor

Example:

curl -X GET "https://app.onflowstack.com/api/v1/connections" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "data": [
    {
      "id": "conn_abc123",
      "name": "Company Gmail",
      "app": "gmail",
      "type": "OAUTH2",
      "status": "ACTIVE",
      "created": "2026-03-01T10:00:00Z",
      "updated": "2026-04-21T09:00:00Z"
    },
    {
      "id": "conn_def456",
      "name": "Production Stripe",
      "app": "stripe",
      "type": "API_KEY",
      "status": "ACTIVE",
      "created": "2026-02-15T14:30:00Z",
      "updated": "2026-04-20T16:00:00Z"
    }
  ],
  "cursor": null,
  "hasMore": false
}

Get Connection

Retrieve a single connection by ID. Credentials are never exposed in the response.

GET /api/v1/connections/{connectionId}

Create Connection (API Key Type)

Create a new API key connection programmatically.

POST /api/v1/connections

Request Body:

{
  "name": "My Stripe Connection",
  "app": "stripe",
  "type": "API_KEY",
  "value": {
    "apiKey": "sk_live_abc123..."
  }
}

Response: 201 Created with the connection object (credentials redacted).

note

OAuth connections cannot be created via API — they require the interactive browser-based authorization flow. Create OAuth connections through the FlowStack dashboard.

Delete Connection

Remove a connection and revoke stored credentials.

DELETE /api/v1/connections/{connectionId}

Response: 204 No Content

caution

Deleting a connection will cause all flows using it to fail on their next execution. Update or deactivate affected flows before deleting.

Connection Status

Status	Description
ACTIVE	Connection is working and credentials are valid
EXPIRED	OAuth token has expired and auto-refresh failed
ERROR	Connection encountered an error (invalid credentials, service unavailable)
REVOKED	User revoked access in the external service