curl "https://tawked.com/v1/partner/usage?from=2026-08-01&to=2026-08-31" \
-H "Authorization: Bearer tk_partner_xxxxxxxxxxxxxxxxxxxx"const res = await fetch("https://tawked.com/v1/partner/usage?from=2026-08-01&to=2026-08-31", {
headers: {
Authorization: "Bearer tk_partner_xxxxxxxxxxxxxxxxxxxx",
},
});
const data = await res.json();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://tawked.com/v1/partner/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
res = requests.get(
"https://tawked.com/v1/partner/usage?from=2026-08-01&to=2026-08-31",
headers={"Authorization": "Bearer tk_partner_xxxxxxxxxxxxxxxxxxxx"},
)
data = res.json(){
"from": "2026-08-01T00:00:00.000Z",
"to": "2026-08-31T00:00:00.000Z",
"balance_halalas": 123456,
"applications": [
{
"external_id": "store_88",
"application_id": "c2a10f3e-8b7a-4d2e-9c1a-1a2b3c4d5e6f",
"name_ar": "متجر الورد",
"sent": 41,
"verified": 33,
"spend_halalas": 369
}
]
}{
"error": "invalid_request",
"message": "`from`/`to` must be ISO dates"
}{
"error": "unauthorized"
}{
"error": "ip_not_allowed"
}{
"error": "too_many_requests"
}{
"error": "internal_error"
}Get usage
Sends, verified codes and spend per application over a date range, plus your current balance. sent counts codes that went out whatever their outcome, verified the ones confirmed, and spend_halalas the charges net of refunds. Applications with no activity in the window are left out, rows are sorted by sent, and there is no paging.
curl "https://tawked.com/v1/partner/usage?from=2026-08-01&to=2026-08-31" \
-H "Authorization: Bearer tk_partner_xxxxxxxxxxxxxxxxxxxx"const res = await fetch("https://tawked.com/v1/partner/usage?from=2026-08-01&to=2026-08-31", {
headers: {
Authorization: "Bearer tk_partner_xxxxxxxxxxxxxxxxxxxx",
},
});
const data = await res.json();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://tawked.com/v1/partner/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
res = requests.get(
"https://tawked.com/v1/partner/usage?from=2026-08-01&to=2026-08-31",
headers={"Authorization": "Bearer tk_partner_xxxxxxxxxxxxxxxxxxxx"},
)
data = res.json(){
"from": "2026-08-01T00:00:00.000Z",
"to": "2026-08-31T00:00:00.000Z",
"balance_halalas": 123456,
"applications": [
{
"external_id": "store_88",
"application_id": "c2a10f3e-8b7a-4d2e-9c1a-1a2b3c4d5e6f",
"name_ar": "متجر الورد",
"sent": 41,
"verified": 33,
"spend_halalas": 369
}
]
}{
"error": "invalid_request",
"message": "`from`/`to` must be ISO dates"
}{
"error": "unauthorized"
}{
"error": "ip_not_allowed"
}{
"error": "too_many_requests"
}{
"error": "internal_error"
}Authorizations
Authorization: Bearer . An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes verify:check, verify:send (includes verify:check), notifications:read, notifications:send (includes notifications:read), email:read, email:send (includes email:read), email:manage (includes email:send), webhooks:manage, email:inbound, notifications:templates (includes notifications:read), chat:menus, chat:attendant. No key made on the API keys page holds notifications:templates, full access included: the three template writes answer such a key 403 insufficient_scope. A connected app's key holds it. Nor chat:menus: the five conversation menu operations answer such a key 403 insufficient_scope, and a connected app's key holds it once the client approved it. Nor chat:attendant: the five auto-attendant operations answer such a key 403 insufficient_scope too, and a connected app's key holds it once the client approved it. email:manage and webhooks:manage are held only by a key someone chose them for: a full-access key, old or new, never holds them. email:inbound, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 insufficient_scope and names the scope it needs in the WWW-Authenticate response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.
Query Parameters
Start of the window, an ISO 8601 date or datetime; 30 days before to when omitted.
End of the window, ISO 8601; now when omitted.