# API

> Do anything you can do in the dashboard from your own systems with an API key: the address, the key, how answers look, errors, limits, and every action.

Source: https://docs.centipidbilling.com/reference/rest-api

## What the API does

Every action in your dashboard has an address. Adding a subscriber, recording a payment, creating a plan, generating vouchers, opening a ticket, rebooting a router: each one is a request to a path such as `/users` or `/packages`. Send the same request with an API key, and your own system can do it too.

The API runs the same steps as a click in the dashboard. The same form checks, the same staff permissions and the same automatic messages apply, so an action behaves the same whichever way it comes in.

A few actions stay in the dashboard because a person has to do them, such as withdrawing money or adding staff. They are listed at the end of this page.

## Who can do this

Any staff member can create a key. A key can do only what its owner's role allows, and only the parts of that you tick when you create it.

## Create a key

#### Open Settings → Developer

Under **API tokens**, enter a name for the key, such as `erp` or `accounting-sync`, so you know which one to revoke later.

#### Tick the permissions the key needs

The list shows what your role allows. Untick everything the integration does not need. A key that only reads payments needs only **Payments - View Main Page**.

#### Copy the key

The key is shown once. Store it in your system's secret store. If it is lost, revoke it and create another.

## Make a request

Send requests to your own workspace address, the one you sign in at, with the key in the `Authorization` header:

```bash
curl -sS https://yourisp.centipidbilling.com/packages \
  -H "Authorization: Bearer YOUR_KEY"
```

To change something, send the form fields as JSON:

```bash
curl -sS -X POST https://yourisp.centipidbilling.com/tickets \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticket_name": "Router offline", "user_id": 42}'
```

`PUT`, `PATCH` and `DELETE` work the same way. Ids in a path, such as `{user}` in `/users/{user}/block`, are the ids the dashboard shows and the API returns.

**Note:**
To find the path and filters for a list, open the page in the dashboard and copy the address from your browser. `/payments?search=0712&page=2` works the same over the API.

## What comes back

**Reading a page** returns the data the dashboard page shows, as JSON:

```json
{
  "component": "tickets/List",
  "props": { "tickets": { "data": [ ... ], "next_page_url": "..." } },
  "url": "/tickets",
  "version": ""
}
```

Everything is under `props`. Long lists come one page at a time: add `?page=2` for the next. Some heavy sections, such as charts, load separately and are named in `deferredProps`. To fetch one, repeat the request with the headers `X-Inertia: true`, `X-Inertia-Version` set to the `version` you got, `X-Inertia-Partial-Component` set to the `component`, and `X-Inertia-Partial-Data` set to the section's name.

**A change** returns the message the dashboard would show, anything the action handed back, and where the dashboard would go next:

```json
{ "message": "Ticket created.", "redirect": "https://yourisp.centipidbilling.com/tickets" }
```

Exports and PDFs come back as the file itself.

## Errors

| Status | Meaning |
|---|---|
| 401 | The key is missing, wrong, revoked or expired. |
| 402 | Your Centipid subscription has expired. Renew it in the dashboard. |
| 403 | The key was not given this permission, the key's owner may not do this, or the action is one a person has to do. `message` says which. |
| 404 | Nothing exists at that path or id. |
| 422 | The action refused the request. `errors` names each field and what is wrong with it. |
| 429 | Too many requests. Each key can make 120 a minute. |

```json
{ "message": "The ticket name field is required.", "errors": { "ticket_name": ["The ticket name field is required."] } }
```

## Keep a key safe

- A key acts as the person who created it. Their name appears in the audit log for everything the key does.
- When that person leaves or is switched off, their keys stop working.
- Revoke a key in **Settings → Developer** the moment you think it has leaked.

## AI assistants

The built-in assistant and assistants connected over [MCP](https://docs.centipidbilling.com/reference/mcp-access) can do any action on this page through the `run_dashboard_action` tool. Each one waits for a person to confirm it in the AI Chat panel first.

## Actions

Each table lists one part of the dashboard and the key permission it needs. A read needs any permission in that part, and a change needs a Create, Edit or Delete permission there. The action itself then checks the exact permission, as the dashboard does.

{/* endpoints:start: generated by scripts/api-endpoints-doc.php */}

366 actions work with a key. 77 do not (listed after the tables).

### Subscribers

Key permission: `users.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| POST | `/binding-operations/{operation}/retry` | binding-operations.retry |  |
| POST | `/customer-segments` | customer-segments.store | `name`* |
| DELETE | `/customer-segments/{customerSegment}` | customer-segments.destroy |  |
| PUT | `/customer-segments/{customerSegment}` | customer-segments.update |  |
| DELETE | `/customer-segments/{customerSegment}/members` | customer-segments.members.destroy |  |
| GET | `/customer-segments/{customerSegment}/members` | customer-segments.members.index |  |
| POST | `/customer-segments/{customerSegment}/members` | customer-segments.members.store |  |
| GET | `/ip-bindings/{ipBinding}/edit` |  |  |
| GET | `/search` | search |  |
| GET | `/users` | users.index |  |
| POST | `/users` | users.store | `note` |
| DELETE | `/users/bulk` | users.bulk-destroy |  |
| POST | `/users/bulk/compensate` | users.bulk-compensate | `minutes`*, `message` |
| POST | `/users/bulk/sms` | users.bulk-sms | `message`* |
| GET | `/users/compensate` | users.compensate |  |
| POST | `/users/compensate` | users.compensate.store | `minutes`*, `notify`*, `message` |
| POST | `/users/compensate/preview` | users.compensate.preview | `groups`*, `groups.*`*, `groups.*.view`*, `groups.*.search`, `groups.*.subs`, `groups.*.subs.*`, `groups.*.package`, `groups.*.nas_id`, `groups.*.visited_within`, `groups.*.created_from`, `groups.*.created_to` |
| GET | `/users/create` | users.create |  |
| GET | `/users/export` | users.export |  |
| POST | `/users/import` | users.import | `rows`*, `rows.*`, `dedup`*, `comment`, `default_type`, `default_package` |
| GET | `/users/import-export` | users.import-export |  |
| POST | `/users/import/mikrotik` | users.import.mikrotik | `nas_id`*, `comment` |
| POST | `/users/import/mikrotik/preview` | users.import.mikrotik.preview | `nas_id`* |
| POST | `/users/import/parse` | users.import.parse | `file`* |
| GET | `/users/import/template` | users.import-template |  |
| GET | `/users/picker` | users.picker |  |
| DELETE | `/users/{user}` | users.destroy | `return_to_form` |
| GET | `/users/{user}` | users.show |  |
| PATCH | `/users/{user}` | users.update |  |
| PUT | `/users/{user}` | users.update |  |
| POST | `/users/{user}/block` | users.block | `reason`, `mac` |
| POST | `/users/{user}/change-expiry` | users.change-expiry | `expiry_date`, `group`, `grace_period`, `grace_period_unit` |
| GET | `/users/{user}/edit` | users.edit |  |
| POST | `/users/{user}/fup-override` | users.fup-override | `mode`*, `reason` |
| POST | `/users/{user}/fup-reset` | users.fup-reset |  |
| POST | `/users/{user}/generate-invoice` | users.generate-invoice |  |
| POST | `/users/{user}/live-speed/watch` | users.live-speed.watch |  |
| POST | `/users/{user}/loyalty/redeem` | users.loyalty.redeem | `package_id`* |
| POST | `/users/{user}/notes` | users.notes.store | `body`* |
| POST | `/users/{user}/pause` | users.pause | `pause_until`, `send_sms`, `message` |
| GET | `/users/{user}/plan-change-quote` | users.plan-change-quote |  |
| GET | `/users/{user}/report.pdf` | users.report-pdf |  |
| POST | `/users/{user}/resume` | users.resume |  |
| POST | `/users/{user}/send-credentials` | users.send-credentials |  |
| POST | `/users/{user}/send-message` | users.send-message | `message` |
| POST | `/users/{user}/send-payment-info` | users.send-payment-info |  |
| POST | `/users/{user}/send-voucher` | users.send-voucher | `package_id`*, `message` |
| POST | `/users/{user}/unblock` | users.unblock | `mac` |

### Live sessions

Key permission: `active_users.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/active-users` | users.active |  |
| POST | `/active-users/bulk/block` | users.active.bulk-block | `sessions`*, `sessions.*.username`*, `sessions.*.mac`, `reason` |
| POST | `/active-users/bulk/disconnect` | users.active.bulk-disconnect | `sessions`*, `sessions.*.username`*, `sessions.*.started_at` |
| POST | `/active-users/bulk/disconnect-until-purchase` | users.active.disconnect-until-purchase | `sessions`*, `sessions.*.username`*, `sessions.*.started_at` |
| POST | `/active-users/bulk/pause` | users.active.bulk-pause | `user_ids`*, `user_ids.*` |
| POST | `/active-users/bulk/sms` | users.active.bulk-sms | `user_ids`*, `user_ids.*`, `message`* |

### Leads

Key permission: `leads.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/leads` | admin.leads |  |
| POST | `/leads` | admin.leads.store | `name`*, `email`, `phone`*, `address`, `city`, `stage`, `source`, `notes`, `temperature`, `assigned_to`, `next_action`, `next_action_due_at`, `plan_of_interest_id` |
| DELETE | `/leads/bulk` | admin.leads.bulk-destroy | `all`, `ids`, `ids.*`, `view`, `stage`, `search`, `owner`, `source`, `hot` |
| GET | `/leads/create` | admin.leads.create |  |
| GET | `/leads/export` | admin.leads.export |  |
| GET | `/leads/export/count` | admin.leads.export.count |  |
| GET | `/leads/import-export` | admin.leads.import-export |  |
| DELETE | `/leads/{lead}` | admin.leads.destroy |  |
| PUT | `/leads/{lead}` | admin.leads.update | `message`, `name`*, `email`, `phone`*, `address`, `city`, `stage`, `source`, `notes`, `temperature`, `assigned_to`, `next_action`, `next_action_due_at`, `plan_of_interest_id` |
| POST | `/leads/{lead}/convert` | admin.leads.convert |  |
| GET | `/leads/{lead}/edit` | admin.leads.edit |  |
| PATCH | `/leads/{lead}/stage` | admin.leads.stage | `stage`* |

### Tickets

Key permission: `tickets.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/tickets` | admin.tickets |  |
| POST | `/tickets` | admin.tickets.store | `ticket_name`*, `description`, `status`, `priority`, `resolution`, `assigned_employee_id`, `notify_user`, `sms`, `resolution_sms`, `resolution_sms_notify` |
| GET | `/tickets/analytics` | admin.tickets.analytics |  |
| GET | `/tickets/create` | admin.tickets.create |  |
| GET | `/tickets/export` | admin.tickets.export |  |
| GET | `/tickets/export/count` | admin.tickets.export.count |  |
| GET | `/tickets/import-export` | admin.tickets.import-export |  |
| GET | `/tickets/list` | admin.tickets.list |  |
| DELETE | `/tickets/{ticket}` | admin.tickets.destroy |  |
| GET | `/tickets/{ticket}` | admin.tickets.show |  |
| PUT | `/tickets/{ticket}` | admin.tickets.update | `message`, `ticket_name`*, `description`, `status`, `priority`, `resolution`, `assigned_employee_id`, `notify_user`, `sms`, `resolution_sms`, `resolution_sms_notify` |
| POST | `/tickets/{ticket}/comments` | admin.tickets.comments | `body`*, `is_internal` |
| GET | `/tickets/{ticket}/edit` | admin.tickets.edit |  |
| POST | `/tickets/{ticket}/status` | admin.tickets.status | `status`* |

### Routers and devices

Key permission: `nas.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/cpe` | admin.cpe |  |
| POST | `/cpe` | admin.cpe.store | `serial_number`*, `label` |
| POST | `/cpe/bulk` | admin.cpe.bulk | `action`*, `ids`*, `ids.*` |
| GET | `/cpe/firmware` | admin.cpe.firmware |  |
| POST | `/cpe/firmware` | admin.cpe.firmware.store | `file`*, `product_class`*, `version`*, `manufacturer`, `oui` |
| POST | `/cpe/firmware/rollouts` | admin.cpe.firmware.rollout | `ids`*, `ids.*`, `message` |
| POST | `/cpe/firmware/rollouts/{rollout}/cancel` | admin.cpe.firmware.cancel |  |
| POST | `/cpe/firmware/rollouts/{rollout}/pause` | admin.cpe.firmware.pause |  |
| POST | `/cpe/firmware/rollouts/{rollout}/resume` | admin.cpe.firmware.resume |  |
| DELETE | `/cpe/firmware/{file}` | admin.cpe.firmware.destroy |  |
| DELETE | `/cpe/{device}` | admin.cpe.destroy |  |
| GET | `/cpe/{device}` | admin.cpe.show |  |
| PATCH | `/cpe/{device}` | admin.cpe.update | `label` |
| POST | `/cpe/{device}/action` | admin.cpe.action | `action`* |
| POST | `/cpe/{device}/diagnostic` | admin.cpe.diagnostic | `type`*, `host`* |
| POST | `/cpe/{device}/firmware` | admin.cpe.firmware.upgrade |  |
| POST | `/cpe/{device}/password` | admin.cpe.password |  |
| POST | `/cpe/{device}/refresh` | admin.cpe.refresh |  |
| POST | `/cpe/{device}/subscriber` | admin.cpe.subscriber |  |
| POST | `/cpe/{device}/wifi` | admin.cpe.wifi |  |
| GET | `/hotspot-ads` | admin.hotspot-ads |  |
| DELETE | `/hotspot-ads/{nas}` | admin.hotspot-ads.disable |  |
| POST | `/hotspot-ads/{nas}` | admin.hotspot-ads.enable | `county`, `town`, `place_type` |
| GET | `/ip-pools` | admin.ip-pools |  |
| POST | `/ip-pools` | admin.ip-pools.store | `name`*, `cidr`*, `nas_id`, `type`*, `reserved` |
| DELETE | `/ip-pools/{ipPool}` | admin.ip-pools.destroy |  |
| GET | `/ip-pools/{ipPool}` | admin.ip-pools.show |  |
| PUT | `/ip-pools/{ipPool}` | admin.ip-pools.update | `name`*, `cidr`*, `nas_id`, `type`*, `reserved` |
| GET | `/ip-pools/{ipPool}/next-free` | admin.ip-pools.next-free |  |
| GET | `/nas` | admin.nas |  |
| POST | `/nas` | admin.nas.store | `version`, `device` |
| GET | `/nas/create` | admin.nas.create |  |
| GET | `/nas/telemetry` | admin.nas.telemetry |  |
| GET | `/nas/{nas}` | admin.nas.show |  |
| POST | `/nas/{nas}/add-fallback-radius` | admin.nas.add-fallback-radius |  |
| POST | `/nas/{nas}/anti-sharing` | admin.nas.anti-sharing | `enabled`* |
| DELETE | `/nas/{nas}/backups/{backup}` | admin.nas.backups.destroy |  |
| GET | `/nas/{nas}/backups/{backup}/download` | admin.nas.backups.download |  |
| POST | `/nas/{nas}/backups/{backup}/restore` | admin.nas.backups.restore |  |
| POST | `/nas/{nas}/captive-portal` | admin.nas.captive-portal | `hotspot_template`, `message` |
| POST | `/nas/{nas}/change-identity` | admin.nas.change-identity |  |
| POST | `/nas/{nas}/check-status` | admin.nas.check-status |  |
| GET | `/nas/{nas}/config-status` | admin.nas.config-status |  |
| POST | `/nas/{nas}/configure` | admin.nas.configure | `services`*, `services.*`, `ports`*, `ports.*`, `use_custom_subnet`, `subnet_address`, `subnet_mask`, `hotspot_antisharing` |
| GET | `/nas/{nas}/connection-status` | admin.nas.connection-status |  |
| GET | `/nas/{nas}/daily-collections` | admin.nas.daily-collections |  |
| POST | `/nas/{nas}/diagnose` | admin.nas.diagnose |  |
| POST | `/nas/{nas}/findings/{finding}/remediate` | admin.nas.remediate-finding |  |
| GET | `/nas/{nas}/health-report` | admin.nas.health-report |  |
| GET | `/nas/{nas}/health-report/export` | admin.nas.health-report.export |  |
| POST | `/nas/{nas}/hotspot-service` | admin.nas.hotspot-service | `enabled`* |
| POST | `/nas/{nas}/hotspot-timeouts` | admin.nas.hotspot-timeouts |  |
| GET | `/nas/{nas}/live-bandwidth` | admin.nas.live-bandwidth |  |
| POST | `/nas/{nas}/live-router-refresh` | admin.nas.live-router-refresh |  |
| GET | `/nas/{nas}/live-system` | admin.nas.live-system |  |
| GET | `/nas/{nas}/live-top-consumers` | admin.nas.live-top-consumers |  |
| GET | `/nas/{nas}/load-balancing` | admin.nas.load-balancing |  |
| POST | `/nas/{nas}/load-balancing` | admin.nas.load-balancing.enable | `balance`* |
| GET | `/nas/{nas}/logs` | admin.nas.logs |  |
| GET | `/nas/{nas}/mac-candidates` | admin.nas.mac-candidates |  |
| POST | `/nas/{nas}/maintenance-mode` | admin.nas.maintenance-mode | `maintenance_message`, `maintenance_allow_login`, `maintenance_until` |
| POST | `/nas/{nas}/monitoring/unwatch` | admin.nas.monitoring.unwatch |  |
| POST | `/nas/{nas}/monitoring/watch` | admin.nas.monitoring.watch |  |
| GET | `/nas/{nas}/payments` | admin.nas.payments |  |
| GET | `/nas/{nas}/payments/export` | admin.nas.payments.export |  |
| POST | `/nas/{nas}/port-settings` | admin.nas.port-settings | `api_port`, `winbox_local_port`, `message` |
| GET | `/nas/{nas}/ports` | admin.nas.ports |  |
| POST | `/nas/{nas}/reboot` | admin.nas.reboot |  |
| POST | `/nas/{nas}/redownload-hotspot` | admin.nas.redownload-hotspot |  |
| POST | `/nas/{nas}/reprovision` | admin.nas.reprovision |  |
| GET | `/nas/{nas}/schedulers` | admin.nas.schedulers |  |
| POST | `/nas/{nas}/schedulers` | admin.nas.schedulers.store | `name`*, `on_event`*, `interval`*, `start_time`, `comment` |
| DELETE | `/nas/{nas}/schedulers/{schedId}` | admin.nas.schedulers.destroy |  |
| GET | `/nas/{nas}/setup` | admin.nas.setup |  |
| POST | `/nas/{nas}/support-number` | admin.nas.support-number | `support_number`*, `message` |
| POST | `/nas/{nas}/sync-router-time` | admin.nas.sync-router-time |  |
| POST | `/nas/{nas}/sync-walled-garden` | admin.nas.sync-walled-garden |  |
| GET | `/nas/{nas}/trends` | admin.nas.trends |  |
| GET | `/nas/{nas}/web-console` | admin.nas.web-console |  |
| POST | `/nas/{nas}/web-service` | admin.nas.web-service | `enabled`* |
| POST | `/nas/{nas}/winbox-service` | admin.nas.winbox-service | `enabled`* |
| GET | `/network-map` | admin.network-map |  |
| DELETE | `/smart-olt` | admin.smart-olt.disconnect |  |
| GET | `/smart-olt` | admin.smart-olt |  |
| POST | `/smart-olt/authorize` | admin.smart-olt.authorize | `olt_id`*, `pon_type`*, `sn`*, `board`, `port`, `onu_type`*, `onu_mode`*, `zone`*, `name`*, `vlan`, `address_or_comment` |
| POST | `/smart-olt/connect` | admin.smart-olt.connect | `subdomain`*, `api_key`* |
| POST | `/smart-olt/onus/{externalId}/action` | admin.smart-olt.onu-action | `action`* |

### Fiber plant

Key permission: `fiber.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| POST | `/fiber/drops` | admin.fiber.drops.store |  |
| DELETE | `/fiber/drops/{drop}` | admin.fiber.drops.destroy |  |
| PUT | `/fiber/drops/{drop}` | admin.fiber.drops.update | `message` |
| GET | `/fiber/geojson` | admin.fiber.geojson |  |
| GET | `/fiber/map` | admin.fiber.map |  |
| POST | `/fiber/nodes` | admin.fiber.nodes.store | `parent_node_id` |
| DELETE | `/fiber/nodes/{node}` | admin.fiber.nodes.destroy |  |
| PUT | `/fiber/nodes/{node}` | admin.fiber.nodes.update | `message` |
| GET | `/fiber/nodes/{node}/impact` | admin.fiber.impact |  |
| GET | `/fiber/nodes/{node}/ports` | admin.fiber.ports.index |  |
| GET | `/fiber/places` | admin.fiber.places |  |
| GET | `/fiber/plant` | admin.fiber.plant |  |
| POST | `/fiber/ports/{port}/assign` | admin.fiber.ports.assign | `fiber_drop_id`, `downstream_node_id` |
| POST | `/fiber/ports/{port}/release` | admin.fiber.ports.release |  |
| POST | `/fiber/routes` | admin.fiber.routes.store |  |
| DELETE | `/fiber/routes/{route}` | admin.fiber.routes.destroy |  |
| PUT | `/fiber/routes/{route}` | admin.fiber.routes.update | `message` |
| GET | `/fiber/routes/{route}/strands` | admin.fiber.strands.index |  |
| POST | `/fiber/routes/{route}/strands` | admin.fiber.strands.assign | `strand_number`*, `assigned_to_node_id`, `label` |
| DELETE | `/fiber/routes/{route}/strands/{strand}` | admin.fiber.strands.release |  |
| GET | `/fiber/subscribers` | admin.fiber.subscribers |  |

### Equipment

Key permission: `equipment.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/equipment` | admin.equipment |  |
| POST | `/equipment` | admin.equipment.store | `name`*, `description`, `serial_number`, `model`, `type`, `price`, `paid_amount`, `status`, `user_id`, `monitoring_enabled`, `alerts_enabled`, `nas_id`, `ip_address`, `mac_address` |
| GET | `/equipment/create` | admin.equipment.create |  |
| DELETE | `/equipment/{equipment}` | admin.equipment.destroy |  |
| PUT | `/equipment/{equipment}` | admin.equipment.update | `name`*, `description`, `serial_number`, `model`, `type`, `price`, `paid_amount`, `status`, `user_id`, `monitoring_enabled`, `alerts_enabled`, `nas_id`, `ip_address`, `mac_address` |
| GET | `/equipment/{equipment}/edit` | admin.equipment.edit |  |

### Plans

Key permission: `packages.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/packages` | admin.packages |  |
| POST | `/packages` | admin.packages.store | `name`*, `type`*, `speed`*, `devices`*, `status`*, `is_hidden`*, `burst_time`, `fup_enabled`*, `fup_limit_gb`, `fup_enforcement_mode`, `fup_throttle_upload_speed`, `fup_throttle_download_speed`, `fup_period`, `schedule_enabled`*, `schedule_start_time`, `schedule_end_time`, `available_days`, `available_days.*`, `nas_ids`, `nas_ids.*`, … |
| POST | `/packages/bulk/set-status` | admin.packages.bulk-set-status | `ids`*, `ids.*`, `status`* |
| GET | `/packages/create` | admin.packages.create |  |
| POST | `/packages/missing` | admin.packages.store-missing | `packages`*, `packages.*` |
| POST | `/packages/reorder` | admin.packages.reorder | `ids`*, `ids.*`, `message` |
| DELETE | `/packages/{package}` | admin.packages.destroy |  |
| GET | `/packages/{package}` | admin.packages.show |  |
| PUT | `/packages/{package}` | admin.packages.update | `name`*, `type`*, `speed`*, `devices`*, `status`*, `is_hidden`*, `burst_time`, `fup_enabled`*, `fup_limit_gb`, `fup_enforcement_mode`, `fup_throttle_upload_speed`, `fup_throttle_download_speed`, `fup_period`, `schedule_enabled`*, `schedule_start_time`, `schedule_end_time`, `available_days`, `available_days.*`, `nas_ids`, `nas_ids.*`, … |
| POST | `/packages/{package}/clear-nas-restriction` | admin.packages.clear-nas-restriction |  |
| POST | `/packages/{package}/duplicate` | admin.packages.duplicate |  |
| GET | `/packages/{package}/edit` | admin.packages.edit |  |
| POST | `/packages/{package}/toggle-on-offer` | admin.packages.toggle-on-offer |  |
| POST | `/packages/{package}/toggle-popular` | admin.packages.toggle-popular |  |
| POST | `/packages/{package}/toggle-status` | admin.packages.toggle-status |  |

### Payments

Key permission: `payments.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/loyalty-points` | admin.loyalty-points |  |
| GET | `/outage-credits` | admin.outage-credits |  |
| GET | `/outage-credits/export` | admin.outage-credits.export |  |
| GET | `/payments` | admin.payments |  |
| POST | `/payments` | admin.payments.store | `amount`*, `payment_method`*, `notes`, `checked`, `renew`, `return_to` |
| GET | `/payments/create` | admin.payments.create |  |
| GET | `/payments/export` | admin.payments.export |  |
| GET | `/payments/export/count` | admin.payments.export-count |  |
| GET | `/payments/import-export` | admin.payments.import-export |  |
| DELETE | `/payments/{payment}` | admin.payments.destroy |  |
| GET | `/payments/{payment}` | admin.payments.show |  |
| PUT | `/payments/{payment}` | admin.payments.update | `amount`*, `payment_method`*, `notes`, `checked`, `renew`, `return_to` |
| GET | `/payments/{payment}/edit` | admin.payments.edit |  |
| POST | `/payments/{payment}/receipt/email` | admin.payments.receipt.email | `email`, `message` |
| GET | `/payments/{payment}/receipt/pdf` | admin.payments.receipt.pdf |  |
| POST | `/payments/{payment}/resend-receipt` | admin.payments.resend-receipt |  |
| GET | `/wallet` | admin.wallet |  |

### Invoices

Key permission: `invoices.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/credit-notes/{creditNote}/pdf` | admin.credit-notes.pdf |  |
| GET | `/invoices` | admin.invoices |  |
| POST | `/invoices` | admin.invoices.store | `user_id`*, `due_date`*, `notes`, `items`*, `items.*.description`*, `items.*.quantity`, `items.*.price`* |
| GET | `/invoices/create` | admin.invoices.create |  |
| POST | `/invoices/preview-draft` | admin.invoices.preview-draft | `user_id`, `due_date`, `notes`, `sample_number`, `items`, `items.*.description`, `items.*.quantity`, `items.*.price` |
| DELETE | `/invoices/{invoice}` | admin.invoices.destroy |  |
| GET | `/invoices/{invoice}` | admin.invoices.show |  |
| PUT | `/invoices/{invoice}` | admin.invoices.update | `message`, `user_id`*, `due_date`*, `notes`, `items`*, `items.*.description`*, `items.*.quantity`, `items.*.price`* |
| POST | `/invoices/{invoice}/cancel` | admin.invoices.cancel |  |
| POST | `/invoices/{invoice}/credit-notes` | admin.invoices.credit-notes.store | `amount`*, `reason`* |
| GET | `/invoices/{invoice}/edit` | admin.invoices.edit |  |
| POST | `/invoices/{invoice}/mark-paid` | admin.invoices.mark-paid | `amount`*, `payment_method`, `receipt` |
| GET | `/invoices/{invoice}/pdf` | admin.invoices.pdf |  |
| GET | `/invoices/{invoice}/preview` | admin.invoices.preview |  |
| POST | `/invoices/{invoice}/send-reminder` | admin.invoices.send-reminder |  |
| POST | `/invoices/{invoice}/send-stk` | admin.invoices.send-stk |  |
| POST | `/invoices/{invoice}/unmark-paid` | admin.invoices.unmark-paid |  |

### Expenses

Key permission: `expenses.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/expenses` | admin.expenses |  |
| POST | `/expenses` | admin.expenses.store | `type`*, `amount`*, `description`, `receipt`, `payment_method`*, `incurred_at`* |
| GET | `/expenses/create` | admin.expenses.create |  |
| DELETE | `/expenses/{expense}` | admin.expenses.destroy |  |
| PUT | `/expenses/{expense}` | admin.expenses.update | `message`, `type`*, `amount`*, `description`, `receipt`, `payment_method`*, `incurred_at`* |
| GET | `/expenses/{expense}/edit` | admin.expenses.edit |  |

### Vouchers and agents

Key permission: `vouchers.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/agents` | admin.agents |  |
| POST | `/agents` | admin.agents.store | `name`*, `email`, `phone`, `password`*, `initial_float` |
| DELETE | `/agents/{agent}` | admin.agents.destroy |  |
| GET | `/agents/{agent}` | admin.agents.show |  |
| PATCH | `/agents/{agent}` | admin.agents.update | `name`*, `email`, `phone`, `message` |
| POST | `/agents/{agent}/assign-batch` | admin.agents.assign-batch | `batch_id`* |
| GET | `/agents/{agent}/ledger/export` | admin.agents.ledger.export |  |
| POST | `/agents/{agent}/top-up` | admin.agents.top-up | `amount`*, `description` |
| GET | `/vouchers` | admin.vouchers |  |
| GET | `/vouchers/batches` | admin.vouchers.batches |  |
| GET | `/vouchers/batches/options` | admin.vouchers.batches.options |  |
| DELETE | `/vouchers/bulk` | admin.vouchers.bulk-destroy | `all`, `ids`, `ids.*`, `tab`, `search`, `package_id`, `batch_id`, `status`, `usage`, `generated_from`, `generated_until`, `expires_from`, `expires_until` |
| POST | `/vouchers/bulk/extend-expiry` | admin.vouchers.bulk-extend-expiry | `expires_at`*, `all`, `ids`, `ids.*`, `tab`, `search`, `package_id`, `batch_id`, `status`, `usage`, `generated_from`, `generated_until`, `expires_from`, `expires_until`, `message` |
| GET | `/vouchers/export` | admin.vouchers.export |  |
| POST | `/vouchers/generate` | admin.vouchers.generate | `package_id`*, `template_id`, `agent_id`, `quantity`*, `charset`, `length`*, `prefix`, `expires_at`, `send_sms`, `phone_number` |
| POST | `/vouchers/import` | admin.vouchers.import |  |
| POST | `/vouchers/import/parse` | admin.vouchers.import.parse |  |
| GET | `/vouchers/import/template` | admin.vouchers.import.template |  |
| GET | `/vouchers/pdf/{uuid}` | admin.vouchers.pdf.download |  |
| POST | `/vouchers/print` | admin.vouchers.print | `tab`, `search`, `package_id`, `batch_id`, `status`, `usage`, `generated_from`, `generated_until`, `expires_from`, `expires_until`, `limit`, `ids`, `ids.*`, `layout`, `color`, `accent`, `template_id` |
| GET | `/vouchers/print/{uuid}/status` | admin.vouchers.print.status |  |
| GET | `/vouchers/sales` | admin.vouchers.sales |  |
| GET | `/vouchers/sales/export` | admin.vouchers.sales.export |  |
| GET | `/vouchers/templates` | admin.vouchers.templates |  |
| POST | `/vouchers/templates` | admin.vouchers.templates.store | `name`*, `config`*, `config.branding.company_name`, `config.branding.logo_url`, `config.branding.accent_color`, `config.branding.color_mode`, `config.header.title`, `config.header.subtitle`, `config.code_style`, `config.fields.show_code`, `config.fields.show_price`, `config.fields.show_duration`, `config.fields.show_speed`, `config.fields.show_expiry`, `config.fields.show_qr`, `config.body.redemption_steps`, `config.body.redemption_steps.*`, `config.body.validity_copy`, `config.footer.support_phone`, `config.footer.support_email`, … |
| GET | `/vouchers/templates/create` | admin.vouchers.templates.create |  |
| POST | `/vouchers/templates/preview` | admin.vouchers.templates.preview | `config`*, `name` |
| DELETE | `/vouchers/templates/{template}` | admin.vouchers.templates.destroy |  |
| PUT | `/vouchers/templates/{template}` | admin.vouchers.templates.update | `message`, `name`*, `config`*, `config.branding.company_name`, `config.branding.logo_url`, `config.branding.accent_color`, `config.branding.color_mode`, `config.header.title`, `config.header.subtitle`, `config.code_style`, `config.fields.show_code`, `config.fields.show_price`, `config.fields.show_duration`, `config.fields.show_speed`, `config.fields.show_expiry`, `config.fields.show_qr`, `config.body.redemption_steps`, `config.body.redemption_steps.*`, `config.body.validity_copy`, `config.footer.support_phone`, … |
| POST | `/vouchers/templates/{template}/default` | admin.vouchers.templates.set-default |  |
| POST | `/vouchers/templates/{template}/duplicate` | admin.vouchers.templates.duplicate |  |
| GET | `/vouchers/templates/{template}/edit` | admin.vouchers.templates.edit |  |
| GET | `/vouchers/{voucher}` | admin.vouchers.show |  |
| POST | `/vouchers/{voucher}/resend-sms` | admin.vouchers.resend-sms | `phone_number`* |

### SMS and WhatsApp

Key permission: `sms.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/sms` | admin.sms |  |
| POST | `/sms` | admin.sms.store | `recipient_mode`*, `user_groups`, `user_groups.*`, `customer_segment_ids`, `customer_segment_ids.*`, `nas_identities`, `nas_identities.*`, `phones`, `phones.*`, `message`* |
| GET | `/sms/campaigns` | admin.sms.campaigns |  |
| POST | `/sms/campaigns` | admin.sms.campaigns.store | `name`*, `channel`*, `subject`, `message`*, `audience_type`*, `audience_filters`, `audience_filters.groups`, `audience_filters.groups.*`, `audience_filters.customer_segment_ids`*, `audience_filters.customer_segment_ids.*`, `audience_filters.nas_identities`, `audience_filters.nas_identities.*`, `audience_filters.user_ids`, `audience_filters.user_ids.*`, `scheduled_for`*, `recurrence_type`, `recurrence_ends_at` |
| GET | `/sms/campaigns/create` | admin.sms.campaigns.create |  |
| DELETE | `/sms/campaigns/{messageCampaign}` | admin.sms.campaigns.destroy |  |
| PUT | `/sms/campaigns/{messageCampaign}` | admin.sms.campaigns.update | `message`*, `name`*, `channel`*, `subject`, `audience_type`*, `audience_filters`, `audience_filters.groups`, `audience_filters.groups.*`, `audience_filters.customer_segment_ids`*, `audience_filters.customer_segment_ids.*`, `audience_filters.nas_identities`, `audience_filters.nas_identities.*`, `audience_filters.user_ids`, `audience_filters.user_ids.*`, `scheduled_for`*, `recurrence_type`, `recurrence_ends_at` |
| GET | `/sms/campaigns/{messageCampaign}/edit` | admin.sms.campaigns.edit |  |
| GET | `/sms/create` | admin.sms.create |  |
| POST | `/sms/estimate` | admin.sms.estimate | `recipient_mode`*, `user_groups`, `user_groups.*`, `customer_segment_ids`, `customer_segment_ids.*`, `nas_identities`, `nas_identities.*`, `phones`, `phones.*`, `message`* |
| GET | `/sms/recipients` | admin.sms.recipients |  |
| POST | `/sms/resend-bulk` | admin.sms.resend-bulk | `all`, `ids`, `ids.*`, `view`, `search` |
| POST | `/sms/{sms}/resend` | admin.sms.resend |  |
| GET | `/whatsapp` | admin.whatsapp |  |
| POST | `/whatsapp` | admin.whatsapp.store | `recipient_mode`*, `user_groups`, `user_groups.*`, `customer_segment_ids`, `customer_segment_ids.*`, `nas_identities`, `nas_identities.*`, `phones`, `phones.*`, `message`* |
| GET | `/whatsapp/create` | admin.whatsapp.create |  |
| POST | `/whatsapp/estimate` | admin.whatsapp.estimate | `recipient_mode`*, `user_groups`, `user_groups.*`, `customer_segment_ids`, `customer_segment_ids.*`, `nas_identities`, `nas_identities.*`, `phones`, `phones.*`, `message`* |
| GET | `/whatsapp/recipients` | admin.whatsapp.recipients |  |
| POST | `/whatsapp/resend-bulk` | admin.whatsapp.resend-bulk | `all`, `ids`, `ids.*`, `view`, `search` |
| POST | `/whatsapp/{sms}/resend` | admin.whatsapp.resend |  |

### Campaigns and promo banners

Key permission: `campaigns.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/campaigns` | admin.campaigns |  |
| POST | `/campaigns` | admin.campaigns.store | `name`*, `type`, `url`, `position`, `image_size`, `start_at`, `end_at` |
| GET | `/campaigns/create` | admin.campaigns.create |  |
| DELETE | `/campaigns/{campaign}` | admin.campaigns.destroy |  |
| PUT | `/campaigns/{campaign}` | admin.campaigns.update | `message`, `name`*, `type`, `url`, `position`, `image_size`, `start_at`, `end_at` |
| GET | `/campaigns/{campaign}/edit` | admin.campaigns.edit |  |

### Analytics

Key permission: `analytics.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/analytics` | admin.analytics |  |
| GET | `/analytics/export` | admin.analytics.export |  |
| POST | `/analytics/targets` | admin.analytics.targets.store | `metric`*, `value`* |
| DELETE | `/analytics/targets/{metric}` | admin.analytics.targets.destroy |  |
| GET | `/dashboard` | dashboard |  |

### Audit log

Key permission: `audits.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/audits` | admin.audits |  |
| GET | `/audits/{audit}` | admin.audits.show |  |

### Referrals

Key permission: `referrals.*`.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/referrals` | referrals |  |
| POST | `/referrals/invite` | referrals.invite | `email` |

### Settings

Key permission: `settings.update` (admins only).

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/settings` | settings.system.index |  |
| GET | `/settings/ai` | settings.ai |  |
| POST | `/settings/ai` |  | `ai_provider`*, `ai_api_key`, `clear_key`, `ai_model` |
| GET | `/settings/branding` | settings.branding |  |
| POST | `/settings/branding` |  | `label`, `logo`, `logo_file`, `color`, `font`, `support_number`, `support_email`, `enable_terms_and_conditions` |
| POST | `/settings/communications/email/test` | settings.communications.email.test | `email`* |
| GET | `/settings/communications/{channel}` | settings.communications.channel |  |
| POST | `/settings/communications/{channel}` |  | `sms_gateway`, `sms_balance_alert_enabled`, `sms_balance_threshold`, `sms_notification_phone`, `enable_whatsapp_gateway`, `whatsapp_gateway` |
| GET | `/settings/communications/{channel}/{provider}` | settings.communications.provider |  |
| POST | `/settings/communications/{channel}/{provider}` |  |  |
| POST | `/settings/communications/{channel}/{provider}/test` | settings.communications.provider.test | `phone`* |
| GET | `/settings/domain` | settings.domain |  |
| POST | `/settings/domain` |  |  |
| DELETE | `/settings/domain/custom` | settings.domain.custom.destroy |  |
| POST | `/settings/domain/custom` | settings.domain.custom.store |  |
| POST | `/settings/domain/custom/verify` | settings.domain.custom.verify |  |
| DELETE | `/settings/domain/dns` | settings.domain.dns.destroy | `name`*, `type`*, `value`* |
| GET | `/settings/domain/dns` | settings.domain.dns.index |  |
| POST | `/settings/domain/dns` | settings.domain.dns.store | `name`*, `type`*, `value`*, `ttl`, `prio` |
| POST | `/settings/domain/dns/recheck` | settings.domain.dns.recheck |  |
| POST | `/settings/domain/dns/verification` | settings.domain.dns.verification |  |
| DELETE | `/settings/domain/retained` | settings.domain.retained.release | `domain`* |
| GET | `/settings/integrations/accounting` | settings.accounting |  |
| DELETE | `/settings/integrations/accounting/sage` | settings.accounting.sage.disconnect |  |
| GET | `/settings/integrations/accounting/sage` | settings.accounting.sage |  |
| POST | `/settings/integrations/accounting/sage` | settings.accounting.sage.update | `sync_payments`*, `sync_contacts`*, `sync_invoices`*, `sync_expenses`*, `bank_account_id`, `sales_ledger_account_id`, `expense_ledger_account_id` |
| DELETE | `/settings/integrations/accounting/zoho` | settings.accounting.zoho.disconnect |  |
| GET | `/settings/integrations/accounting/zoho` | settings.accounting.zoho |  |
| POST | `/settings/integrations/accounting/zoho` | settings.accounting.zoho.update | `sync_payments`*, `sync_contacts`*, `sync_invoices`*, `sync_expenses`*, `bank_account_id`, `sales_ledger_account_id`, `expense_ledger_account_id` |
| POST | `/settings/integrations/accounting/zoho/retry` | settings.accounting.zoho.retry |  |
| GET | `/settings/loyalty` | settings.loyalty |  |
| POST | `/settings/loyalty` |  | `loyalty_enabled`, `loyalty_amount_threshold`, `loyalty_points_per_earn`, `loyalty_min_redemption`, `loyalty_redemption_value`, `loyalty_service_types`, `loyalty_service_types.*`, `loyalty_nas_ids`, `loyalty_nas_ids.*` |
| GET | `/settings/message-templates` | settings.message-templates |  |
| POST | `/settings/message-templates` |  | `pppoe_payment_confirmation_sms_enabled`, `pppoe_payment_confirmation_sms`, `pppoe_welcome_sms_enabled`, `pppoe_welcome_sms`, `hotspot_payment_confirmation_sms_enabled`, `hotspot_payment_confirmation_sms`, `hotspot_payment_confirmation_sms_new_users_only`, `pppoe_expiry_notification_enabled`, `pppoe_expiry_notification`, `hotspot_expiry_notification_enabled`, `hotspot_expiry_notification`, `pppoe_expiry_reminder_notification_enabled`, `pppoe_expiry_reminder_notification`, `hotspot_expiry_reminder_notification_enabled`, `hotspot_expiry_reminder_notification`, `bundle_warning_notification_enabled`, `bundle_warning_notification_percentage`, `bundle_warning_notification`, `bundle_exhausted_notification_enabled`, `bundle_exhausted_notification`, … |
| GET | `/settings/network/hotspot` | settings.network.hotspot |  |
| POST | `/settings/network/hotspot` |  | `hotspot_inactive_prune_days`, `username_prefix`, `hotspot_redirect_url`, `unused_voucher_expiry_days`, `hotspot_template`, `hotspot_section_order`, `hotspot_section_order.*`, `hotspot_section_order.*.*`, `hotspot_language`, `hotspot_time_starts_on`, `hotspot_instructions`, `hotspot_instructions.*.title`, `hotspot_instructions.*.text`, `hotspot_background_file`, `hotspot_template_background` |
| GET | `/settings/network/pppoe` | settings.network.pppoe |  |
| POST | `/settings/network/pppoe` |  | `pppoe_inactive_prune_days`, `pppoe_trial_days`, `pppoe_fup_notification_thresholds`, `pppoe_fup_notification_thresholds.*`, `pppoe_notification_hours`, `pppoe_notification_hours.*`, `enable_invoices`, `invoice_prefix`, `subscriber_wallet_enabled`, `portal_show_usage`, `package_price_notice_enabled`, `package_price_notice_days`, `package_price_notice_sms` |
| GET | `/settings/notifications` | settings.notifications |  |
| POST | `/settings/notifications` |  | `mikrotik_status_notifications_enabled`, `mikrotik_notification_phone_numbers`, `mikrotik_notification_phone_numbers.*`, `mikrotik_alert_channels`, `mikrotik_alert_channels.*`, `mikrotik_whatsapp_phone_numbers`, `mikrotik_whatsapp_phone_numbers.*`, `mikrotik_notification_emails`, `mikrotik_notification_emails.*`, `payment_alert_enabled`, `payment_alert_phone_numbers`, `payment_alert_phone_numbers.*`, `prefer_whatsapp_for_payment_alerts`, `payment_alert_types`, `payment_alert_types.*`, `expiry_change_alert_enabled`, `sales_notifications_enabled`, `sales_notification_frequency`, `router_health_digest_enabled`, `outage_compensation_enabled`, … |
| DELETE | `/settings/notifications/telegram` | settings.notifications.telegram.disconnect |  |
| POST | `/settings/notifications/telegram/test` | settings.notifications.telegram.test |  |
| GET | `/settings/sender-id` | settings.sender-id |  |
| GET | `/settings/sender-id/payment-status` | settings.sender-id.payment-status |  |

### Centipid feedback and changelog

Key permission: any key.

| Method | Path | Action | Fields (* required) |
|---|---|---|---|
| GET | `/changelog` | changelog |  |
| POST | `/feedback` | feedback.store | `type`*, `title`*, `description`* |
| GET | `/feedback-board` | feedback.board |  |
| POST | `/feedback/{feedbackSubmission}/upvote` | feedback.upvote |  |

## What a key cannot do

These stay in the dashboard, because a person has to do them.

| Method | Path | Why |
|---|---|---|
| POST | `/agents/{agent}/action-otp` | Sends a verification code to a person. |
| POST | `/agents/{agent}/password-reset` | Resetting a password needs a code from a person. |
| POST | `/ai-chat/conversations` | This part of the dashboard is not available with an API key. |
| GET | `/ai-chat/conversations/{conversation}` | This part of the dashboard is not available with an API key. |
| POST | `/ai-chat/conversations/{conversation}/actions/{action}/confirm` | This part of the dashboard is not available with an API key. |
| POST | `/ai-chat/conversations/{conversation}/actions/{action}/reject` | This part of the dashboard is not available with an API key. |
| POST | `/ai-chat/conversations/{conversation}/messages` | This part of the dashboard is not available with an API key. |
| GET | `/ai-chat/state` | This part of the dashboard is not available with an API key. |
| DELETE | `/cpe/network-login` | Hands out network passwords. |
| POST | `/cpe/network-login` | Hands out network passwords. |
| GET | `/mcp/oauth/connections` | This part of the dashboard is not available with an API key. |
| DELETE | `/mcp/oauth/connections/{grant}` | This part of the dashboard is not available with an API key. |
| GET | `/mcp/oauth/consent/{handoff}` | This part of the dashboard is not available with an API key. |
| POST | `/mcp/oauth/consent/{handoff}` | This part of the dashboard is not available with an API key. |
| DELETE | `/nas/{nas}` | Deleting a router needs a code from a person. |
| POST | `/nas/{nas}/action-otp` | Sends a verification code to a person. |
| POST | `/nas/{nas}/deletion-otp` | Sends a verification code to a person. |
| DELETE | `/nas/{nas}/load-balancing` | Turning load balancing off needs a code from a person. |
| POST | `/nas/{nas}/regenerate-winbox` | Hands out router passwords. |
| POST | `/nas/{nas}/simulate-online` | A demo tool, not an ISP action. |
| POST | `/nas/{nas}/winbox-access` | Hands out router passwords. |
| POST | `/payments/withdraw` | Moving money out of the ISP needs the withdrawal code sent to a person. |
| POST | `/payments/withdraw/otp` | Moving money out of the ISP needs the withdrawal code sent to a person. |
| GET | `/payments/withdraw/quote` | Moving money out of the ISP needs the withdrawal code sent to a person. |
| GET | `/payments/withdraw/recipient` | Moving money out of the ISP needs the withdrawal code sent to a person. |
| POST | `/settings/branding/support-email/otp` | Sends a verification code to a person. |
| POST | `/settings/branding/support-email/verify` | Checks a code sent to a person. |
| POST | `/settings/communications/sms/topup` | Spends the ISP's own money with Centipid. |
| GET | `/settings/communications/sms/topup/status` | Spends the ISP's own money with Centipid. |
| GET | `/settings/developer` | A key cannot create keys or webhooks. |
| POST | `/settings/developer/tokens` | A key cannot create keys or webhooks. |
| DELETE | `/settings/developer/tokens/{id}` | A key cannot create keys or webhooks. |
| POST | `/settings/developer/webhooks` | A key cannot create keys or webhooks. |
| DELETE | `/settings/developer/webhooks/{id}` | A key cannot create keys or webhooks. |
| POST | `/settings/developer/webhooks/{id}/test` | A key cannot create keys or webhooks. |
| POST | `/settings/developer/webhooks/{id}/toggle` | A key cannot create keys or webhooks. |
| POST | `/settings/domain/buy` | Spends the ISP's own money with Centipid. |
| GET | `/settings/domain/buy/paypal/cancel` | Spends the ISP's own money with Centipid. |
| GET | `/settings/domain/buy/paypal/return` | Spends the ISP's own money with Centipid. |
| POST | `/settings/domain/buy/search` | Spends the ISP's own money with Centipid. |
| GET | `/settings/domain/buy/status` | Spends the ISP's own money with Centipid. |
| POST | `/settings/domain/buy/verify-email` | Spends the ISP's own money with Centipid. |
| POST | `/settings/integrations/accounting/sage/connect` | Connecting an accounting system signs in through a browser. |
| POST | `/settings/integrations/accounting/zoho/connect` | Connecting an accounting system signs in through a browser. |
| POST | `/settings/notifications/telegram/connect` | Connecting Telegram happens in a browser. |
| GET | `/settings/payments` | Payment gateway credentials are secrets a person enters. |
| POST | `/settings/payments` | Payment gateway credentials are secrets a person enters. |
| POST | `/settings/payments/otp` | Sends a verification code to a person. |
| POST | `/settings/payments/safaricom/register-callbacks` | Payment gateway credentials are secrets a person enters. |
| POST | `/settings/payments/till-number-request` | Payment gateway credentials are secrets a person enters. |
| GET | `/settings/payments/till-number-request/status` | Payment gateway credentials are secrets a person enters. |
| GET | `/settings/payments/{gateway}` | Payment gateway credentials are secrets a person enters. |
| POST | `/settings/sender-id/initiate-payment` | Spends the ISP's own money with Centipid. |
| GET | `/sso/continue/{handoff}` | This part of the dashboard is not available with an API key. |
| GET | `/staff` | Staff, roles and passwords are managed by a person. |
| POST | `/staff` | Staff, roles and passwords are managed by a person. |
| PUT | `/staff/roles/{roleId}` | Staff, roles and passwords are managed by a person. |
| DELETE | `/staff/{userId}` | Staff, roles and passwords are managed by a person. |
| PUT | `/staff/{userId}` | Staff, roles and passwords are managed by a person. |
| POST | `/staff/{userId}/action-otp` | Sends a verification code to a person. |
| POST | `/staff/{userId}/impersonate` | Staff, roles and passwords are managed by a person. |
| POST | `/staff/{userId}/password-reset` | Staff, roles and passwords are managed by a person. |
| GET | `/subscription` | This part of the dashboard is not available with an API key. |
| GET | `/subscription/collections/{externalId}/status` | This part of the dashboard is not available with an API key. |
| POST | `/subscription/credit/topup` | This part of the dashboard is not available with an API key. |
| GET | `/subscription/credit/topups/{topup}` | This part of the dashboard is not available with an API key. |
| GET | `/subscription/invoices/{invoice}/pdf` | This part of the dashboard is not available with an API key. |
| GET | `/subscription/invoices/{invoice}/pppoe-users` | This part of the dashboard is not available with an API key. |
| GET | `/subscription/mpesa/{reference}/status` | This part of the dashboard is not available with an API key. |
| POST | `/subscription/pay` | This part of the dashboard is not available with an API key. |
| POST | `/subscription/pay/iotec` | This part of the dashboard is not available with an API key. |
| POST | `/subscription/pay/mpesa` | This part of the dashboard is not available with an API key. |
| POST | `/subscription/pay/paypal` | This part of the dashboard is not available with an API key. |
| POST | `/subscription/pay/wallet` | This part of the dashboard is not available with an API key. |
| POST | `/subscription/wallet/autopay` | This part of the dashboard is not available with an API key. |
| POST | `/subscription/win-back` | This part of the dashboard is not available with an API key. |
| POST | `/users/{user}/view-portal` | Opens a browser session as the subscriber. |

{/* endpoints:end */}

## Related pages

- [AI assistant access (MCP)](https://docs.centipidbilling.com/reference/mcp-access)
- [Staff and permissions](https://docs.centipidbilling.com/subscribers/staff-and-permissions)
