a13nDocs
API referenceConnections

List Connections

GET/api/v1/connections

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Query Parameters

limit?Limit
Range1 <= value <= 100
Default50
cursor?string|null

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/connections"
{  "items": [    {      "auth": "none",      "authorization_pending": true,      "client_secret_configured": true,      "config": {        "headers": [],        "oauth": {          "client_id": "string",          "grant_type": "authorization_code",          "scopes": [],          "token_endpoint_auth_method": "none"        },        "tools": [          "string"        ],        "url": "string"      },      "connector_provider_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "created_by_id": "string",      "credential_configured": true,      "enabled": true,      "failure": {        "code": "string",        "operation_id": "string",        "operation_kind": "setup",        "reason": "rejected"      },      "id": "string",      "last_test": {        "connection_version": 0,        "message": "string",        "status": "succeeded",        "tested_at": "2019-08-24T14:15:22Z"      },      "name": "string",      "organization_id": "string",      "status": "pending",      "type": "string",      "updated_at": "2019-08-24T14:15:22Z",      "updated_by_id": "string",      "version": 0,      "workspace_id": "string"    }  ],  "next_cursor": "string"}