MiaRec REST API
The MiaRec REST API lets third-party applications operate on MiaRec resources, such as call recordings, users, groups, and tenants, using only HTTP and JSON. Use it to integrate MiaRec with a CRM, a workforce management system, a business intelligence tool, or your own provisioning scripts.
Where to start
- Architecture: how a client talks to the API.
- Security and authentication: create an API user and grant it the REST API permission.
- Message encoding, Collections, and Error responses: the conventions shared by all endpoints.
- Rate limits: request quotas and how to stay within them.
- Create tenant with roles, groups, and users: a step-by-step example with curl.
API Explorer
Every MiaRec web server publishes an interactive API Explorer (Swagger UI) together with the
OpenAPI specification of the REST API at https://{your-miarec-server}/api/v2. For the hosted
platform, open https://app.miarec.com/api/v2. See
API Explorer.
Resources
| Resource | Base URL | Operations |
|---|---|---|
| Calls | /api/v2/calls.json |
List and search, view, set custom fields, delete, download audio, pause and resume recording |
| Users | /api/v2/users.json |
List and search, view, create, update, delete, pause and resume recording |
| Groups | /api/v2/groups.json |
List and search, view, create, update, delete |
| Roles | /api/v2/roles.json |
List and search, view, create, update, delete |
| Tenants | /api/v2/tenants.json |
List and search, view, create, update, delete, branding |
| Extensions | /api/v2/extensions.json |
List and search, view, create, update, delete |
| Clients | /api/v2/clients.json |
List and search, view, create, update, delete |
| Custom fields | /api/v2/custom_fields.json |
List and search, view, create, update, delete |
| Encryption keys | /api/v2/encrypt_keys.json |
List and search, view, create, update, delete, grant and revoke access |
| Evaluation forms | /api/v2/evaluation_forms.json |
List and search, view |
| Evaluation reports | /api/v2/evaluation_reports.json |
List and search, view |
| Report templates | /api/v2/reports.json |
List and search, view |
| Report runs | /api/v2/reports/{id}/runs.json |
List, view, retrieve data |
| Usage metrics | /api/v2/tenants/{id}/usage/... |
Daily transcription and AI usage of a tenant |
Versioning
The current version of the API is v2, addressed by the /api/v2/ prefix. New attributes and
endpoints are added without changing the version. Attributes are not removed or renamed within a
version without a transition period; such changes are listed in
History of changes.