GET /project/{project_id} — Retrieve Project Details

Use this endpoint to retrieve the full details of an Convo project, including its linked WhatsApp number, current subscription plan status, Monthly Active User (MAU) usage, quality rating, and billing information.

Endpoint

GET https://connect.api-wa.co/project-apis/v1/project/{project_id}

Path Parameters

string

required

The unique ID of your project. You can find this in the Convo dashboard under Settings → Developers → API Keys, or in the project_ids array returned by the Get Business endpoint.

Request Example

curl https://connect.api-wa.co/project-apis/v1/project/61f06252cf0a58553378ceb5 \
  -H "X-API-WA-Project-API-Pwd: YOUR_API_PASSWORD"

Response (200 OK)

string

The unique identifier of the project.

string

The unique name assigned to this project within Convo.

string

Current status of the project. One of:

active — fully operational
pending — awaiting setup or verification
suspended — temporarily disabled
stopped — service stopped due to billing or policy
archived — decommissioned and read-only

boolean

true if WhatsApp phone number verification is still pending. When true, the project operates in sandbox mode with limited messaging capabilities.

string

The identifier of the project’s current subscription plan (e.g. GROWTH, ENTERPRISE).

number

Unix timestamp in milliseconds representing the start date of the current subscription cycle.

number

Unix timestamp in milliseconds representing the next renewal date of the subscription.

number

The maximum number of Monthly Active Users (MAUs) included in the current plan.

number

The number of MAUs consumed so far in the current billing cycle.

number

WhatsApp Conversation Credit (WCC) balance available for this project. The value is stored at ×10⁵ precision — divide by 100000 to get the balance in your billing currency.

string

The WhatsApp Business phone number registered to this project, including country code (e.g. 911234567890).

string

The daily template message limit tier granted by Meta. Higher tiers unlock larger per-day send volumes.

string

The WhatsApp display name shown to recipients when they receive messages from this number.

string

Verification status of the WhatsApp display name as determined by Meta (e.g. APPROVED, PENDING_REVIEW).

string

The Facebook Business Manager verification status linked to this project (e.g. VERIFIED, NOT_VERIFIED).

string

The current WhatsApp quality rating assigned by Meta based on recent messaging behavior. One of low, medium, or high. A low rating can restrict messaging throughput.

string

The “About” text visible on the WhatsApp Business profile for this number.

string

URL of the WhatsApp Business profile picture for this number.

object

An object containing the detailed WhatsApp Business profile information.

Show wa_business_profile fields

string

Physical address of the business as shown on the WhatsApp profile.

string

A short description of the business displayed on the WhatsApp Business profile.

string

Business contact email shown on the WhatsApp profile.

string

The industry or business category (e.g. RETAIL, EDUCATION, HEALTH).

array of strings

A list of website URLs associated with the business on the WhatsApp profile. Up to two URLs are supported.

string

The currency used for billing this project (e.g. INR, USD).

string

The timezone configured for this project. Affects campaign scheduling and analytics reporting.

Response Example

{
  "id": "61f06252cf0a58553378ceb5",
  "name": "MakeMyDay-Gurgaon",
  "status": "active",
  "sandbox": false,
  "active_plan": "GROWTH",
  "plan_activated_on": 1643143755321,
  "plan_renewal_on": 1675679755321,
  "mau_quota": 1000,
  "mau_usage": 243,
  "credit": 5000000,
  "wa_number": "911234567890",
  "wa_messaging_tier": "TIER_1K",
  "wa_display_name": "MakeMyDay Gurgaon",
  "wa_display_name_status": "APPROVED",
  "fb_business_manager_status": "VERIFIED",
  "wa_quality_rating": "high",
  "wa_about": "Your one-stop shop for daily essentials in Gurgaon.",
  "wa_display_image": "https://cdn.convo.com/profiles/61f06252cf0a58553378ceb5.jpg",
  "wa_business_profile": {
    "address": "Plot 12, Sector 44, Gurgaon, Haryana 122003",
    "description": "MakeMyDay delivers groceries and essentials to your doorstep across Gurgaon.",
    "email": "support@makemyday.in",
    "vertical": "RETAIL",
    "websites": [
      "https://www.makemyday.in",
      "https://shop.makemyday.in"
    ]
  },
  "billing_currency": "INR",
  "timezone": "Asia/Calcutta"
}

Error Responses

object

Returned when no project matching the provided project_id exists, or the authenticated key does not have access to it.

{
  "name": "ERR404",
  "message": "Project not found!"
}

object

Returned when an unexpected error occurs on Convo’s servers. Retry the request with exponential back-off.

{
  "name": "ERR500",
  "message": "Internal server error."
}

Overview

Business & Project

Messages

Contacts

Templates

Campaigns

Webhooks

Catalogue

Media

GET /project/{project_id} — Retrieve Project Details

Endpoint

Path Parameters

Request Example

Response (200 OK)

Response Example

Error Responses

​Endpoint

​Path Parameters

​Request Example

​Response (200 OK)

​Response Example

​Error Responses

Endpoint

Path Parameters

Request Example

Response (200 OK)

Response Example

Error Responses