v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Agent Channels

List channel integrations

Returns the account's connected channel integrations (WhatsApp, Instagram, Messenger) and which agent each number/account/page is bound to. Connecting a channel requires the OAuth flow in the app and is not available via the API. Requires a USER API key.

get/public/v1/channels

Response

The account's channel integrations (null if none connected)

idnumber required
accountIdnumber required

Example response

{
  "id": 1,
  "accountId": 1,
  "whatsapp": {
    "id": 1,
    "integrationId": 1,
    "status": "PENDING",
    "integratedById": 1,
    "integratedBy": {
      "firstName": "example",
      "lastName": "example",
      "avatar": "example"
    },
    "phoneNumbers": [
      {
        "id": 1,
        "phoneNumberId": "example",
        "assistantId": "example",
        "assistant": {
          "id": "example",
          "name": "example"
        },
        "status": "CONNECTED",
        "wabaId": "example",
        "name": "example",
        "about": "example",
        "description": "example",
        "address": "example",
        "category": "AUTO",
        "displayPhoneNumber": "example",
        "website": "example",
        "secondaryWebsite": "example",
        "verificationStatus": "VERIFIED",
        "image": "example",
        "email": "example",
        "createdAt": "example",
        "updatedAt": "example"
      }
    ],
    "allocationId": "example",
    "expirationTime": "example",
    "createdAt": "example",
    "updatedAt": "example"
  },
  "instagram": {
    "id": 1,
    "integrationId": 1,
    "status": "PENDING",
    "integratedById": 1,
    "integratedBy": {
      "firstName": "example",
      "lastName": "example",
      "avatar": "example"
    },
    "instagramAccounts": [
      {
        "id": 1,
        "instagramUserId": "example",
        "username": "example",
        "accountType": "BUSINESS",
        "profilePictureUrl": "example",
        "followersCount": 1,
        "mediaCount": 1,
        "assistantId": "example",
        "createdAt": "example",
        "updatedAt": "example"
      }
    ],
    "tokenExpiresAt": "example",
    "createdAt": "example",
    "updatedAt": "example"
  },
  "messenger": {
    "id": 1,
    "integrationId": 1,
    "status": "PENDING",
    "integratedById": 1,
    "integratedBy": {
      "firstName": "example",
      "lastName": "example",
      "avatar": "example"
    },
    "messengerPages": [
      {
        "id": 1,
        "messengerPageId": "example",
        "businessAccountId": "example",
        "pageName": "example",
        "pageType": "business",
        "pagePictureUrl": "example",
        "followersCount": 1,
        "likesCount": 1,
        "assistantId": "example",
        "createdAt": "example",
        "updatedAt": "example"
      }
    ],
    "createdAt": "example",
    "updatedAt": "example"
  }
}