Account

Base: /v2/me

Auth + Premium/Enterprise + active plan required (see overview — Access rules). Does not require phoneNumberId in the request.

Also read: HTTP API v2 Overview

---

GET /v2/me

Returns the user and WhatsApp account context for the token, and all phone numbers linked to that account (for choosing phoneNumberId on Messages and Templates sends).

Field in data	Description
user	{ id, email }
account	{ id, wabaid } — Meta WhatsApp Business Account id used for templates/forms list
phoneNumbers	Array of numbers registered in AvenPing for this account
defaultPhoneNumberId	Meta Phone number ID when exactly one number exists; otherwise null (pick from phoneNumbers when multiple lines are connected)

Each element of phoneNumbers:

Field	Description
id	AvenPing internal id (cuid)
phoneNumberId	Meta Phone number ID — use this in message/template bodies
phoneNumber	Display / E.164-style number string
name	Optional label
isRegistered	Registration flag from AvenPing DB
createdAt	ISO 8601 timestamp

Example request:

curl -sS "https://api.avenping.com/v2/me" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response 200 (two numbers — defaultPhoneNumberId is null):

{
  "success": true,
  "data": {
    "user": {
      "id": "clu01exampleuserid0001",
      "email": "[email protected]"
    },
    "account": {
      "id": "clu01exampleaccountid01",
      "wabaid": "102290129012901"
    },
    "phoneNumbers": [
      {
        "id": "clx01phoneinternal0001",
        "phoneNumberId": "109876543210987",
        "phoneNumber": "+15551234567",
        "name": "Support line",
        "isRegistered": true,
        "createdAt": "2025-01-15T10:00:00.000Z"
      },
      {
        "id": "clx01phoneinternal0002",
        "phoneNumberId": "209876543210988",
        "phoneNumber": "+15557654321",
        "name": "Sales",
        "isRegistered": true,
        "createdAt": "2025-03-01T14:30:00.000Z"
      }
    ],
    "defaultPhoneNumberId": null
  }
}

Response 200 (single number — default set):

{
  "success": true,
  "data": {
    "user": {
      "id": "clu01exampleuserid0001",
      "email": "[email protected]"
    },
    "account": {
      "id": "clu01exampleaccountid01",
      "wabaid": "102290129012901"
    },
    "phoneNumbers": [
      {
        "id": "clx01phoneinternal0001",
        "phoneNumberId": "109876543210987",
        "phoneNumber": "+15551234567",
        "name": null,
        "isRegistered": true,
        "createdAt": "2025-01-15T10:00:00.000Z"
      }
    ],
    "defaultPhoneNumberId": "109876543210987"
  }
}

---

Related

• Webhooks (outbound URL + code)
• Templates
• Messages
• HTTP API v2 Overview