> ## Documentation Index
> Fetch the complete documentation index at: https://ownpay.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> OwnPay is licensed under AGPL-3.0 and is completely free - no licensing fees.
> Production docs URL: https://ownpay.org/docs - append .md to any page URL for clean markdown.
> OwnPay requires PHP 8.3+, MySQL/MariaDB, and Redis.
> MCP server available at https://ownpay.org/docs/mcp for programmatic documentation queries.
> Use root-relative links (e.g. /quickstart) for internal navigation - do NOT include /docs prefix.
> Plugin development: consult /developer/plugin-types/ pages for correct interfaces and manifests.

# Admin API Reference - SMS, Domains, and Device Management

> Admin API endpoints for managing SMS templates, outbound SMS queues, paired devices, and domain verification on the OwnPay master domain.

The Admin API provides administrative endpoints for managing SMS templates, outbound SMS queues, paired devices, and domain verification. This API is only accessible on the master domain.

## Base URL

```text theme={null}
https://{master_domain}/api/admin/v1
```

<Warning>
  The Admin API is only accessible on the master domain (`APP_DOMAIN`). It cannot be accessed through custom brand domains.
</Warning>

## Authentication

All endpoints require a Bearer token with `admin` scope:

```http theme={null}
Authorization: Bearer YOUR_ADMIN_API_KEY
```

## Key Endpoints

| Endpoint               | Description              |
| ---------------------- | ------------------------ |
| `GET /sms-templates`   | List SMS templates       |
| `PUT /sms-templates`   | Update SMS template      |
| `GET /sms-queue`       | List outbound SMS queue  |
| `GET /devices`         | List paired devices      |
| `POST /domains/verify` | Verify custom domain DNS |

<Note>
  Full API documentation is auto-generated from the OpenAPI specification.
</Note>


## Related topics

- [Submit Received SMS](/docs/api-reference/submit-received-sms.md)
- [Get Pending Outbound SMS](/docs/api-reference/get-pending-outbound-sms.md)
- [List SMS Templates](/docs/api-reference/list-sms-templates.md)
- [Retry Outbound SMS](/docs/api-reference/retry-outbound-sms.md)
- [Update SMS Template](/docs/api-reference/update-sms-template.md)
