# Matomo Users Manager API

**Canonical:** https://apis.io/apis/matomo/matomo-usersmanager-api/  
**Provider:** Matomo — https://apis.io/providers/matomo/  
**Base URL:** https://{matomo_host}/index.php  
**Documentation:** https://developer.matomo.org/api-reference/reporting-api

Matomo Users Manager API is one of 61 APIs that [Matomo](https://apis.io/providers/matomo/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include UsersManager. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

The UsersManager API lets you Manage Users and their permissions to access specific websites. You can create users via "addUser", update existing users via "updateUser" and delete users via "deleteUser". There are many ways to list users based on their login "getUser" and "getUsers", their email "getUserByEmail", or which users have permission (view or admin) to access the specified websites "getUsersWithSiteAccess". Existing Permissions are listed given a login via "getSitesAccessFromUser", or a website ID via "getUsersAccessFromSite", or you can list all users and websites for a given permission via "getUsersSitesFromAccess". Permissions are set and updated via the method "setUserAccess". See also the documentation about <a href='https://matomo.org/docs/manage-users/' rel='noreferrer' target='_blank'>Managing Users</a> in Matomo.

## Operations (32)

| Method | Path | Summary |
|---|---|---|
| GET | `/index.php?module=API&method=UsersManager.getAvailableRoles` | — |
| GET | `/index.php?module=API&method=UsersManager.getAvailableCapabilities` | — |
| GET | `/index.php?module=API&method=UsersManager.setUserPreference` | — |
| GET | `/index.php?module=API&method=UsersManager.getUserPreference` | — |
| GET | `/index.php?module=API&method=UsersManager.getUsersPlusRole` | — |
| GET | `/index.php?module=API&method=UsersManager.getUsers` | — |
| GET | `/index.php?module=API&method=UsersManager.getUsersLogin` | — |
| GET | `/index.php?module=API&method=UsersManager.getUsersSitesFromAccess` | — |
| GET | `/index.php?module=API&method=UsersManager.getUsersAccessFromSite` | — |
| GET | `/index.php?module=API&method=UsersManager.getUsersWithSiteAccess` | — |
| GET | `/index.php?module=API&method=UsersManager.getSitesAccessFromUser` | — |
| GET | `/index.php?module=API&method=UsersManager.getSitesAccessForUser` | — |
| GET | `/index.php?module=API&method=UsersManager.getUser` | — |
| GET | `/index.php?module=API&method=UsersManager.getUserByEmail` | — |
| GET | `/index.php?module=API&method=UsersManager.addUser` | — |
| GET | `/index.php?module=API&method=UsersManager.inviteUser` | — |
| GET | `/index.php?module=API&method=UsersManager.setSuperUserAccess` | — |
| GET | `/index.php?module=API&method=UsersManager.hasSuperUserAccess` | — |
| GET | `/index.php?module=API&method=UsersManager.getUsersHavingSuperUserAccess` | — |
| GET | `/index.php?module=API&method=UsersManager.updateUser` | — |
| GET | `/index.php?module=API&method=UsersManager.deleteUser` | — |
| GET | `/index.php?module=API&method=UsersManager.logoutUser` | — |
| GET | `/index.php?module=API&method=UsersManager.userExists` | — |
| GET | `/index.php?module=API&method=UsersManager.userEmailExists` | — |
| GET | `/index.php?module=API&method=UsersManager.getUserLoginFromUserEmail` | — |
| GET | `/index.php?module=API&method=UsersManager.setUserAccess` | — |
| GET | `/index.php?module=API&method=UsersManager.addCapabilities` | — |
| GET | `/index.php?module=API&method=UsersManager.removeCapabilities` | — |
| GET | `/index.php?module=API&method=UsersManager.createAppSpecificTokenAuth` | — |
| GET | `/index.php?module=API&method=UsersManager.newsletterSignup` | — |
| GET | `/index.php?module=API&method=UsersManager.resendInvite` | — |
| GET | `/index.php?module=API&method=UsersManager.generateInviteLink` | — |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-usersmanager-api-openapi.yml
- **Documentation** — https://developer.matomo.org/api-reference/reporting-api
- **Documentation** — https://developer.matomo.org/api-reference/reporting-api#Live
- **Documentation** — https://developer.matomo.org/api-reference/reporting-api#Goals
- **Documentation** — https://developer.matomo.org/api-reference/reporting-api-segmentation

## Other Matomo APIs (12)

- [Matomo Reporting API (index.php entrypoint)](https://apis.io/apis/matomo/matomo-index-php-api/)
- [Matomo Tracking API (matomo.php entrypoint)](https://apis.io/apis/matomo/matomo-matomo-php-api/)
- [Matomo Ab Testing API](https://apis.io/apis/matomo/matomo-abtesting-api/)
- [Matomo Actions API](https://apis.io/apis/matomo/matomo-actions-api/)
- [Matomo Activity Log API](https://apis.io/apis/matomo/matomo-activitylog-api/)
- [Matomo Advertising Conversion Export API](https://apis.io/apis/matomo/matomo-advertisingconversionexport-api/)
- [Matomo Annotations API](https://apis.io/apis/matomo/matomo-annotations-api/)
- [Matomo API](https://apis.io/apis/matomo/matomo-api-api/)
- [Matomo API Reference API](https://apis.io/apis/matomo/matomo-apireference-api/)
- [Matomo Bandwidth API](https://apis.io/apis/matomo/matomo-bandwidth-api/)
- [Matomo Cohorts API](https://apis.io/apis/matomo/matomo-cohorts-api/)
- [Matomo Contents API](https://apis.io/apis/matomo/matomo-contents-api/)

## Tags

UsersManager

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/matomo/matomo-usersmanager-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/matomo/.