Number Shield & stats

Health

GET/v2/numbers/{numberId}/health

Scope:stats:read
Idempotency-Key:not used
read only

Score, level, reasons, warm-up stage and caps, usage today, pauses, restrictions (reach-out lock), trusted links.

Parameters

Path

Name	Type	Constraints	Description
`numberId`required	Type`string`	Constraints—	DescriptionNumber id (GET /v2/numbers).

Headers

Name	Type	Constraints	Description
`X-Request-Id`optional	Type`string`	Constraints—	DescriptionOptional: your own request id, echoed back (otherwise we generate `req_…`). Quote it to support.

Request

GET /v2/numbers/{numberId}/health

curl -X GET "https://mursilat.com/api/v2/numbers/cm1abcd2345efgh6789ijkl/health" \
  -H "Authorization: Bearer $WASLA_API_KEY"

const res = await fetch('https://mursilat.com/api/v2/numbers/cm1abcd2345efgh6789ijkl/health', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.WASLA_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
console.log(data);

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['WASLA_API_KEY']}"}
res = requests.get(
    "https://mursilat.com/api/v2/numbers/cm1abcd2345efgh6789ijkl/health",
    headers=headers,
    timeout=30,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
print(data)

<?php
$ch = curl_init('https://mursilat.com/api/v2/numbers/cm1abcd2345efgh6789ijkl/health');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('WASLA_API_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($status >= 400) { throw new Exception($data['error']['code'] . ': ' . $data['error']['message']); }
print_r($data);

Response

200Example

200 — application/json

{
  "numberId": "cm1abcd2345efgh6789ijkl",
  "score": 86,
  "level": "good",
  "reasons": [],
  "warmup": {
    "stage": "WEEK_2",
    "source": "AGE",
    "nextStageAt": "2026-10-20T09:00:00.000Z",
    "ageDays": 9
  },
  "caps": {
    "coldPerDay": 100,
    "coldPerHour": 25,
    "warmPerDay": 1000
  },
  "customLimits": {
    "maxPerDay": null,
    "maxPerHour": null,
    "minGapSeconds": null
  },
  "usageToday": {
    "coldToday": 12,
    "warmToday": 40,
    "coldLastHour": 3,
    "resetsAt": "…"
  },
  "pause": null,
  "restrictions": {
    "reachoutLocked": false,
    "linksTrusted": false,
    "linksAllowedToNewContacts": true
  }
}

Response schema

Fields of the example answer. Expand objects and arrays.

responseobject10 fields
- numberIdstring "cm1abcd2345efgh6789ijkl"
- scoreinteger 86
- levelstring "good"
- reasonsarray []
- warmupobject4 fields
  - stagestring "WEEK_2"
  - sourcestring "AGE"
  - nextStageAtstring "2026-10-20T09:00:00.000Z"
  - ageDaysinteger 9
- capsobject3 fields
  - coldPerDayinteger 100
  - coldPerHourinteger 25
  - warmPerDayinteger 1000
- customLimitsobject3 fields
  - maxPerDaynull null
  - maxPerHournull null
  - minGapSecondsnull null
- usageTodayobject4 fields
  - coldTodayinteger 12
  - warmTodayinteger 40
  - coldLastHourinteger 3
  - resetsAtstring "…"
- pausenull null
- restrictionsobject3 fields
  - reachoutLockedboolean false
  - linksTrustedboolean false
  - linksAllowedToNewContactsboolean true

Errors

Only the common authentication, rate-limit and validation errors.

Errors →

Try it

Send this request from your browser to the Mursilat API.

documented example

Preview — this copy of the docs isn’t on mursilat.com, so the console shows the documented example instead of calling the API.

Real requests use your real number and plan: they can send WhatsApp messages, spend quota and delete data. (read only)

API key

Kept only in this tab’s memory: never saved, never put in the URL, sent only to mursilat.com. Reloading the page forgets it.

Path parameters

numberId