Skip to main content
GET
/
api
/
v1
/
user
/
list
/
UserWhatsApp
Read Userwhatsapp List
curl --request GET \
  --url 'https://api.example.com/api/v1/user/list/UserWhatsApp?api_key='
{
  "data": {
    "items": [
      {
        "phone_number_id": "<string>",
        "phone_business_id": "<string>",
        "facebook_app_secret": "<string>",
        "whatsapp_access_token": "<string>",
        "whatsapp_phone_number": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "total": 1,
    "page": 2,
    "size": 2,
    "pages": 1,
    "previous_page": 123,
    "next_page": 123
  },
  "message": "",
  "meta": {}
}

Authorizations

​
api_key
string
query
required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
size
integer
default:50
Required range: 1 <= x <= 100

Response

Successful Response

​
data
PageBase[IUserWhatsAppRead] · object
required
​
message
string | null
default:""
​
meta
Meta · object