Numbers

Get number (Meta details)

Returns the number + all Meta info when it is an official-API number: a nested meta block (phone / profile / waba, camelCase) with quality, messaging-limit tier, verification status, business profile and WABA data, plus health. Served from cache by default; pass ?refresh=1 to fetch live from the Meta Graph and persist. Non-Meta numbers return meta: null. (The same route accepts DELETE to remove; use GET /api/v1/numbers/:id/status for a lightweight state-only poll.)

GET

numbers

{id}

curl --request GET \
  --url https://pilotstatus.com.br/v1/numbers/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "num_01HZX...",
  "number": "+5511999999999",
  "name": "Atendimento",
  "provider": "META",
  "state": "OPEN",
  "isFullyConnected": true,
  "health": {
    "qualityRating": "GREEN",
    "messagingLimitTier": "TIER_2K",
    "metaStatus": "CONNECTED",
    "sendable": true
  },
  "meta": {
    "fetchedAt": "2026-06-30T08:55:00.000Z",
    "phone": {
      "displayPhoneNumber": "+55 11 99999-9999",
      "verifiedName": "Minha Empresa",
      "qualityRating": "GREEN",
      "status": "CONNECTED",
      "codeVerificationStatus": "VERIFIED",
      "nameStatus": "APPROVED",
      "platformType": "CLOUD_API",
      "throughput": {
        "level": "STANDARD"
      },
      "messagingLimitTier": "TIER_2K",
      "businessManagerMessagingLimit": "TIER_2K",
      "accountMode": "LIVE"
    },
    "profile": {
      "about": "Atendimento oficial",
      "email": "contato@empresa.com",
      "websites": [
        "https://empresa.com"
      ],
      "vertical": "PROF_SERVICES"
    },
    "waba": {
      "id": "1234567890",
      "name": "Empresa WABA",
      "currency": "BRL",
      "businessVerificationStatus": "verified",
      "accountReviewStatus": "APPROVED",
      "ownershipType": "CLIENT"
    },
    "errors": {}
  }
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Path Parameters

string

required

WhatsApp number id.

Query Parameters

refresh

string

Pass 1 to force a live fetch from the Meta Graph and refresh the cache.

Response

Get Meta number

Remote pairing (connection link)

Delete number

⌘I

Get number (Meta details)

curl --request GET \
  --url https://pilotstatus.com.br/v1/numbers/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "num_01HZX...",
  "number": "+5511999999999",
  "name": "Atendimento",
  "provider": "META",
  "state": "OPEN",
  "isFullyConnected": true,
  "health": {
    "qualityRating": "GREEN",
    "messagingLimitTier": "TIER_2K",
    "metaStatus": "CONNECTED",
    "sendable": true
  },
  "meta": {
    "fetchedAt": "2026-06-30T08:55:00.000Z",
    "phone": {
      "displayPhoneNumber": "+55 11 99999-9999",
      "verifiedName": "Minha Empresa",
      "qualityRating": "GREEN",
      "status": "CONNECTED",
      "codeVerificationStatus": "VERIFIED",
      "nameStatus": "APPROVED",
      "platformType": "CLOUD_API",
      "throughput": {
        "level": "STANDARD"
      },
      "messagingLimitTier": "TIER_2K",
      "businessManagerMessagingLimit": "TIER_2K",
      "accountMode": "LIVE"
    },
    "profile": {
      "about": "Atendimento oficial",
      "email": "contato@empresa.com",
      "websites": [
        "https://empresa.com"
      ],
      "vertical": "PROF_SERVICES"
    },
    "waba": {
      "id": "1234567890",
      "name": "Empresa WABA",
      "currency": "BRL",
      "businessVerificationStatus": "verified",
      "accountReviewStatus": "APPROVED",
      "ownershipType": "CLIENT"
    },
    "errors": {}
  }
}