Skip to main content
GET
/
v1
/
channels
List channels
curl --request GET \
  --url https://api.cuadra.ai/v1/channels \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "channelType": "sms",
      "webhookUrl": "<string>",
      "systemPromptId": "<string>",
      "modelId": "<string>",
      "datasetIds": [
        "<string>"
      ],
      "welcomeMessage": "<string>",
      "fallbackMessage": "<string>",
      "status": "active",
      "lastError": "<string>",
      "lastErrorAt": "2023-11-07T05:31:56Z",
      "conversationCount": 123,
      "messageCount": 123,
      "lastMessageAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "phoneNumber": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": false
}

Authorizations

​
Authorization
string
header
required

JWT token from Stytch B2B authentication (magic link, SSO, or M2M)

Query Parameters

​
status
enum<string> | null
Available options:
active,
paused,
error
​
channelType
enum<string> | null

Supported channel types.

Available options:
sms,
whatsapp,
telegram,
slack

Response

Successful Response

Response schema for channel list.

​
items
ChannelOut · object[]
required
​
nextCursor
string | null
​
hasMore
boolean
default:false