Engagive API documentation

Channels · WhatsApp · Accounts

Account APIs

Base URL & auth

  • Prefix: /api/business/public on https://api.engagive.io (full base: https://api.engagive.io/api/business/public).
  • Header: Authorization: Bearer <token> — create the token under Profile → API access token in the business app.
  • See also: Authentication, Errors & responses.

List and fetch WhatsApp accounts for your business (read-only). Response includes account_id and phone_id for other public APIs (messages, campaigns, etc.). Account create/delete stays in the portal (Embedded Signup).

GET

List WhatsApp accounts

Required permission: WhatsApp — View

Lists accounts for your business. Includes account_id and phone_id (use `phone_id` when creating campaigns).

Path
/api/business/public/channels/whatsapp/accounts
Example success response (JSON)
{
  "success": true,
  "statusCode": 200,
  "data": [
    {
      "account_id": 1,
      "account_name": "Acme Support",
      "is_active": true,
      "phone_id": 5,
      "phone_number": "+92 300 1234567",
      "verified_name": "Acme",
      "profile_id": 3,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-08-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "totalCount": 1,
    "totalPages": 1
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
GET https://api.engagive.io/api/business/public/channels/whatsapp/accounts?page=1&pageSize=20
GET

Get WhatsApp account

Required permission: WhatsApp Detail — View

Account detail including phone_id, profile fields, and websites.

Path
/api/business/public/channels/whatsapp/accounts/:accountId
Example success response (JSON)
{
  "success": true,
  "statusCode": 200,
  "data": {
    "account_id": 1,
    "account_name": "Acme Support",
    "wa_business_id": "123456789",
    "is_active": true,
    "phone_id": 5,
    "phone_number": "+92 300 1234567",
    "verified_name": "Acme",
    "profile_id": 3,
    "quality_rating": "GREEN",
    "websites": [
      "https://example.com"
    ]
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
GET https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1