List channels
The channels you work in: all of them for an administrator, the agent's own for an agent.
The whole list comes at once (next_cursor is always null). A disconnected channel
hidden from the workspace (hidden: true) is listed only with include_hidden=true.
Authorization
personalToken Your personal access token from Profile → Access Token in Lalexi. It acts with exactly your role: what you may see and do in the workspace, and nothing more. Everything done with it is recorded as done by you.
In: header
Query Parameters
Also list the channels hidden from the workspace.
falseHeader Parameters
The workspace to work in (an id from GET /me). Optional when you belong to a single
workspace; required otherwise (400 workspace_required).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://app.lalexi.com/v1/channels" \ -H "X-Workspace-Id: 7"{
"data": [
{
"id": 0,
"name": "string",
"type": "whatsapp",
"status": "connected",
"connected_by": {
"id": 0,
"name": "string"
},
"note": "string",
"hidden": true,
"capabilities": {
"can_start_dialog": true,
"reply_only": true,
"attachments": true,
"chat_list": true,
"broadcasts": true
},
"created_at": "2019-08-24T14:15:22Z"
}
],
"next_cursor": "string"
}{
"error": {
"code": "workspace_required",
"message": "You belong to several workspaces: pass the X-Workspace-Id header."
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key is missing or invalid."
}
}{
"error": {
"code": "forbidden",
"message": "You are not allowed to do this."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found."
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the number of seconds in Retry-After."
}
}{
"error": {
"code": "internal_error",
"message": "Something went wrong on our side."
}
}