APIAPI Reference
Connections
/connections
List connections for the organization
Authorization
apiKeyAuth AuthorizationBearer <token>
Backend API key for server-to-server calls. Format: sk_live_... or sk_test_...
In: header
Query Parameters
agent_id?string
Format
uuidlimit?integer
Default
20Range
1 <= value <= 100after?string
before?string
Response Body
application/json
curl -X GET "http://localhost:3002/v1/backend/connections"{
"data": [
{
"connection_code": "string",
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"invite_type": "open",
"auth_style": "always",
"channel_type": "hosted",
"available_modes": [
"string"
],
"default_mode": "string",
"max_uses": 0,
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"has_more": true,
"next_cursor": "string",
"prev_cursor": "string"
}
}/connections/{code}
Get a single connection by connection code
Authorization
apiKeyAuth AuthorizationBearer <token>
Backend API key for server-to-server calls. Format: sk_live_... or sk_test_...
In: header
Path Parameters
code*string
Response Body
application/json
application/json
curl -X GET "http://localhost:3002/v1/backend/connections/string"{
"data": {
"connection_code": "string",
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"invite_type": "open",
"auth_style": "always",
"channel_type": "hosted",
"available_modes": [
"string"
],
"default_mode": "string",
"max_uses": 0,
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
}{
"error": {
"code": "string",
"message": "string"
}
}