Skip to main content
GET
/
public
/
v1
/
chat
/
channels
cURL
curl -X GET "https://api.copera.ai/public/v1/chat/channels?q=deploy&kind=group" \
  -H "Authorization: Bearer YOUR_TOKEN"
{
  "channels": [
    {
      "_id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "kind": "<string>",
      "participantUserIds": [
        "<string>"
      ],
      "participantTeamIds": [
        "<string>"
      ],
      "createdBy": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "description": "<string>",
      "picture": "<string>",
      "lastMessageAt": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

​
Overview

Returns the chat channels and direct-message conversations visible to the token user.

​
Query Parameters

ParamTypeDescription
qstringOptional case-insensitive search over channel name, custom DM name, description, and participant name/email.
typestringOptional channel type filter, such as text, voice, meeting, or whatsapp.
kindstringOptional channel kind filter: group or dm.
participantIdstringOptional user or team ID that must participate in the returned channels.
limitnumberOptional result limit, 1-200. Defaults to 100.
offsetnumberOptional pagination offset. Defaults to 0.

​
Usage Notes

  • Use this endpoint before send-message when a script needs to resolve a channel ID.
  • DM names are resolved for the token user when the DM has no custom name.
  • Results are scoped to the token workspace and participant access.

Authorizations

​
Authorization
string
header
required

Bearer token

Query Parameters

​
q
string

Case-insensitive search over channel name, custom DM name, description, and participant name/email.

Maximum string length: 200
​
type

Filter by channel type.

Available options:
category
​
kind

Filter by channel kind.

Available options:
group
​
participantId
string

Return channels containing this user or team participant.

Required string length: 24
Pattern: ^[0-9a-fA-F]{24}$
​
limit
number

Max results (1-200). Defaults to 100.

Required range: 1 <= x <= 200
​
offset
number

Pagination offset. Defaults to 0.

Required range: x >= 0

Response

Default Response

​
channels
object[]
required
​
total
number
required
​
limit
number
required
​
offset
number
required