Channels

List channels

Lists the channels connected in the project.

get/v1/projects/{project_id}/channels

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/channels
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Query parameters

limitinteger

Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an integer it is 400.

cursorstring

Opaque pagination cursor from a previous response's next_cursor.

Response

A page of channels.

next_cursorstring nullable required

Cursor for the next page, or null when there are no more.

Example response

{
  "data": [
    {
      "id": "chan_V1StGXR8Z5jdHi6B",
      "project_id": "proj_V1StGXR8Z5jdHi6B",
      "channel": "whatsapp",
      "status": "active",
      "credential_source": "byot",
      "phone_number_id": "109999999999999",
      "waba_id": "104444444444444",
      "display_phone_number": "+55 11 90000-0001",
      "verified_name": "Acme Suporte",
      "application_id": "1290000000000000000",
      "modes": {
        "dms": true
      },
      "default": {
        "action": "agent",
        "agent_id": "agent_V1StGXR8Z5jdHi6B",
        "text": "Subscribe at https://example.com/pricing",
        "language": "en-US",
        "config": {
          "media": {
            "audio": "transcribe"
          },
          "discord": {
            "allowed_role_ids": [
              "1290000000000000042"
            ]
          }
        }
      },
      "max_context_messages": 20,
      "has_credential": true,
      "gateway_error": {
        "close_code": 4004
      },
      "created_at": "2026-07-23T00:00:00.000Z",
      "updated_at": "2026-07-23T00:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.