Rasel / Docs
EN
GET/api/v2/templates

List templates

With no officialSenderId this returns every visible template. Each row includes officialSender, isPlatformNumber, headerType, headerAssetId, headerPreviewUrl, and allowsHeaderMediaOverride. Default status filter is active and approved.

When to use it. Before sending with template.key or template.id.

Code example

Correct: Approved WhatsApp templates

curl --location 'https://raselsms.com/api/v2/templates' \--header 'X-API-Key: YOUR_API_KEY'

Response example

200 — Approved WhatsApp templates

{  "data": [    {      "id": "6800tpl123def4567890aaaa",      "name": "order_ready_notice",      "category": "whatsapp",      "subType": "utility",      "language": "ar",      "status": "approved",      "headerType": "image",      "headerValue": null,      "headerAssetId": null,      "headerPreviewUrl": null,      "allowsHeaderMediaOverride": true,      "provider": "meta",      "officialSenderId": "platform",      "officialSender": {        "id": "platform",        "scope": "platform",        "isPlatform": true,        "isDefault": true,        "label": null,        "phoneNumber": null,        "displayName": "platform"      },      "isPlatformNumber": true,      "isDefault": false,      "createdAt": "2026-09-01T10:00:00.000Z"    },    {      "id": "6800tpl123def4567890bbbb",      "name": "promo_offer",      "category": "whatsapp",      "subType": "utility",      "language": "ar",      "status": "approved",      "headerType": "image",      "headerValue": null,      "headerAssetId": null,      "headerPreviewUrl": null,      "allowsHeaderMediaOverride": true,      "provider": "meta",      "officialSenderId": "6800abc123def4567890abcd",      "officialSender": {        "id": "6800abc123def4567890abcd",        "scope": "official_sender",        "isPlatform": false,        "isDefault": false,        "label": "SAWA",        "phoneNumber": "+963911111111",        "displayName": "SAWA · +963911111111"      },      "isPlatformNumber": false,      "isDefault": false,      "createdAt": "2026-09-01T10:00:00.000Z"    }  ]}

401 — Missing or invalid API key.

{  "success": false,  "requestId": "msgreq_1739012345678_abc123",  "code": "UNAUTHORIZED",  "error": "Missing or invalid API key"}

403 — Phone is not verified or the key lacks permission (usually messages:create or api_keys:read).

{  "success": false,  "requestId": "msgreq_1739012345678_abc123",  "code": "FORBIDDEN",  "error": "Phone not verified or missing permission"}

429 — Rate limit exceeded. Honor Retry-After when present.

{  "success": false,  "requestId": "msgreq_1739012345678_abc123",  "code": "RATE_LIMITED",  "error": "Rate limit exceeded",  "retryAfterSeconds": 30}

HTTP request

GET /api/v2/templates

Request Headers

HeaderTypeDescription
X-API-KeystringYour Rasel API key. Send it on every documented request except inbound webhooks. *

Query parameters

FieldTypeDescription
categorywhatsapp | sms | message | emailTemplate category: whatsapp, sms, message, or email.
statuspending | approved | rejected | active | disabledDelivery or record status. On send: sent, queued, or scheduled. On other resources it is the row status filter or value.
provideruser_session | meta | internalTemplate provider filter or value: user_session, meta, or internal.
officialSenderIdstringOfficial WhatsApp sender id from /api/v2/official-senders. Alias of sender.officialId. Use platform for the default Meta number when listing templates.

Response Fields

FieldTypeDescriptionExample
datajsonPrimary payload for list and snapshot endpoints.

Status Codes

StatusDescription
200Success.
401Missing or invalid API key.
404Resource not found for this API key owner.
429Rate limit exceeded, or the maximum number of verification attempts was reached.
403Phone not verified, missing permission, or the account cannot perform this action.

Try it

Parameters

Template category: whatsapp, sms, message, or email.

Delivery or record status. On send: sent, queued, or scheduled. On other resources it is the row status filter or value.

Template provider filter or value: user_session, meta, or internal.

Official WhatsApp sender id from /api/v2/official-senders. Alias of sender.officialId. Use platform for the default Meta number when listing templates.

Request

GET /api/v2/templates?category=whatsapp&status=pending&provider=user_session

Response

Send a request to see the response.