Skip to main content
GET
/
whatsapp
/
resources
List WhatsApp resources
curl --request GET \
  --url https://api.otpiq.com/api/whatsapp/resources \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "project": {
      "id": "65a0a0a0a0a0a0a0a0a0a0a0",
      "slug": "my-project",
      "name": "My Project"
    },
    "summary": {
      "businessCount": 1,
      "accountCount": 2,
      "phoneNumberCount": 3,
      "templateCount": 12
    },
    "businesses": [
      {
        "id": "65b1b1b1b1b1b1b1b1b1b1b1",
        "businessId": "123456789012345",
        "name": "Business 123456789012345",
        "whatsappAccounts": [
          {
            "id": "65c2c2c2c2c2c2c2c2c2c2c2",
            "whatsappBusinessId": "987654321098765",
            "name": "My WABA",
            "accountReviewStatus": "APPROVED",
            "businessVerificationStatus": "verified",
            "banState": "",
            "banDate": "",
            "violationType": "",
            "phoneNumbers": [
              {
                "id": "65d3d3d3d3d3d3d3d3d3d3d3",
                "phoneNumberId": "112233445566778",
                "displayPhoneNumber": "+964 770 123 4567",
                "phoneNumber": "+9647701234567",
                "verifiedName": "My Business",
                "qualityRating": "GREEN",
                "messagingLimit": "TIER_1K",
                "status": "CONNECTED",
                "codeVerificationStatus": "VERIFIED",
                "isOfficialBusinessAccount": false,
                "nameStatus": "APPROVED",
                "createdAt": "2026-01-15T10:00:00.000Z"
              }
            ],
            "templates": [
              {
                "id": "65e4e4e4e4e4e4e4e4e4e4e4",
                "name": "otp_verification",
                "category": "AUTHENTICATION",
                "parameter_format": "POSITIONAL",
                "language": "en",
                "messageSendTtlSeconds": 600,
                "reason": "",
                "status": "APPROVED",
                "isWhatsappFlow": false,
                "createdAt": "2026-01-20T08:30:00.000Z"
              }
            ],
            "createdAt": "2026-01-10T12:00:00.000Z"
          }
        ],
        "createdAt": "2026-01-10T12:00:00.000Z"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.otpiq.com/llms.txt

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

For large integrations, start with includeTemplateComponents=false and only request full template components when you need to render or inspect template structure.

Authorizations

​
Authorization
string
header
required

Project API key (sk_live… or sk_dev…). Send it as Authorization: Bearer <api_key>.

Query Parameters

​
includeTemplateComponents
boolean
default:false

When true, each template includes its full components array (header, body, buttons, etc.). When false, only template metadata is returned. Accepted values: true, false, 1, 0 (case-insensitive).

Example:

true

Response

WhatsApp resources retrieved successfully.

​
success
boolean
required
Example:

true

​
data
object
required