Appearance
Subscribers
A subscriber is a customer: a name and how to reach them. A subscriber holds one or more devices and belongs to an account, a reseller or you, which pays for its devices.
json
{
"id": 7,
"name": "Anna Berg",
"phone": "+49 151 2345678",
"email": "[email protected]",
"note": null,
"reseller_id": 3,
"devices": 2,
"created_at": "2026-10-01T09:12:00Z"
}| Field | |
|---|---|
reseller_id | The account it belongs to |
devices | How many devices it has |
List
GET /subscribers| Filter | |
|---|---|
search | Part of the name, phone or email |
reseller_id | One account's subscribers |
Paged: see Lists and paging.
sh
curl "https://panel.example.com/api/rest/v1/subscribers?search=berg" \
-H "Authorization: Bearer mtx_your_key"Read
GET /subscribers/{id}Add
POST /subscribers| Field | ||
|---|---|---|
name | Required | Up to 255 characters |
phone | Up to 64 characters | |
email | An email address | |
note | Up to 1000 characters | |
reseller_id | The account it belongs to. Without it, the key's own account. An administrator's key may name any reseller; a reseller's key itself or one of its sub-resellers. |
sh
curl -X POST https://panel.example.com/api/rest/v1/subscribers \
-H "Authorization: Bearer mtx_your_key" \
-H "Content-Type: application/json" \
-d '{"name": "Anna Berg", "email": "[email protected]", "reseller_id": 3}'Answers 201 with the subscriber.
Change
PATCH /subscribers/{id}Any of name, phone, email, note. The account cannot be changed here.
Delete
DELETE /subscribers/{id}Only a subscriber without devices: otherwise 409 has_devices. Answers 204.