Skip to main content
GET
/
v1
/
whatsapp
/
senders
List Senders
curl --request GET \
  --url https://karibu.briq.tz/v1/whatsapp/senders \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "<string>",
    "phone_number_id": "<string>",
    "display_number": "<string>",
    "is_default": true,
    "is_active": true,
    "is_deleted": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "whatsapp_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>"
  }
]

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-API-Key
string
required
​
X-App-ID
string | null

Query Parameters

​
is_active
boolean | null

Filter senders by active state.

​
is_default
boolean | null

Filter senders by default flag.

Response

Successful Response

​
id
string<uuid>
required

Unique identifier of the sender. Use this as sender_id when sending.

​
user_id
string
required
​
phone_number_id
string
required
​
display_number
string
required

Human-readable display number (E.164 without the + prefix).

​
is_default
boolean
required
​
is_active
boolean
required
​
is_deleted
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
whatsapp_account_id
string<uuid> | null
​
label
string | null