Saltar al contenido principal
GET
/
v1
/
channels
curl -X GET "https://api.contactship.ai/v1/channels" \
  -H "x-api-key: your-api-key"

{
  "data": [
    {
      "id": "chn_y0xspd9p1v7vla6wkwc2z01u",
      "name": "WhatsApp Business",
      "type": "WABA",
      "status": "active",
      "answer_method": "auto",
      "organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "created_at": "2026-01-15T10:00:00Z"
    },
    {
      "id": "chn_a1b2c3d4e5f6g7h8i9j0k1l2",
      "name": "Instagram DMs",
      "type": "INSTAGRAM",
      "status": "active",
      "answer_method": "manual",
      "organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "created_at": "2026-02-01T09:00:00Z"
    }
  ],
  "count": 2
}

Documentation Index

Fetch the complete documentation index at: https://docs.contactship.ai/llms.txt

Use this file to discover all available pages before exploring further.

Returns all messaging channels configured for your organization (WhatsApp WABA, Instagram, etc.). Use the id from each channel as the channel_id parameter in messaging endpoints like Send WhatsApp Message.

​
Headers

​
x-api-key
string
requerido
Your API key for authentication.

​
Query Parameters

​
limit
number
predeterminado:"10"
Maximum number of channels to return.
​
offset
number
predeterminado:"0"
Number of records to skip for pagination.
​
order
string
predeterminado:"desc"
Sort direction by creation date. Possible values: asc, desc.
​
status
string
Filter by channel status (e.g. active, inactive).
​
type
string
Filter by channel type (e.g. WABA, INSTAGRAM).
​
name
string
Filter by channel name (partial match).
​
answer_method
string
Filter by answer method. Possible values: manual, auto.

​
Response

​
data
array
Array of channel objects.
​
count
number
Total number of channels matching the query.

​
Error Codes

  • 401 Unauthorized — Invalid or missing API key
  • 500 Internal Server Error — Server-side error

​
Code Examples

curl -X GET "https://api.contactship.ai/v1/channels" \
  -H "x-api-key: your-api-key"

{
  "data": [
    {
      "id": "chn_y0xspd9p1v7vla6wkwc2z01u",
      "name": "WhatsApp Business",
      "type": "WABA",
      "status": "active",
      "answer_method": "auto",
      "organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "created_at": "2026-01-15T10:00:00Z"
    },
    {
      "id": "chn_a1b2c3d4e5f6g7h8i9j0k1l2",
      "name": "Instagram DMs",
      "type": "INSTAGRAM",
      "status": "active",
      "answer_method": "manual",
      "organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "created_at": "2026-02-01T09:00:00Z"
    }
  ],
  "count": 2
}