Menu

Caution

As of 2025-03-11, Grafana OnCall OSS has entered maintenance mode, and will be archived on 2026-03-24. No further feature development will occur; however, we will still provide fixes for critical bugs and for valid CVEs with a CVSS score of 7.0 or higher. For more information, refer to our blog post.

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana OnCallbreadcrumb arrow Grafana OnCall HTTP API referencebreadcrumb arrow Grafana OnCall Users HTTP API
Open source

Get a user

This endpoint retrieves the user object.

shell 
```shell
curl "{{API_URL}}/api/v1/users/current/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

The above command returns JSON structured in the following way:

json 
{
    "id": "U4DNY931HHJS5",
    "email": "public-api-demo-user-1@grafana.com",
    "slack": [
        {
            "user_id": "UALEXSLACKDJPK",
            "team_id": "TALEXSLACKDJPK"
        }
    ],
    "username": "alex",
    "role": "admin"
}

HTTP request

GET {{API_URL}}/api/v1/users/<USER_ID>/

Use {{API_URL}}/api/v1/users/current to retrieve the current user.

ParameterUniqueDescription
idYes/orgUser ID
emailYes/orgUser e-mail
slackYes/orgList of user IDs from connected Slack. User linking key is e-mail.
usernameYes/orgUser username
roleNoOne of: user, observer, admin.

List Users

shell 
curl "{{API_URL}}/api/v1/users/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

The above command returns JSON structured in the following way:

json 
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "U4DNY931HHJS5",
            "email": "public-api-demo-user-1@grafana.com",
            "slack": [
                {
                    "user_id": "UALEXSLACKDJPK",
                    "team_id": "TALEXSLACKDJPK"
                }
            ],
            "username": "alex",
            "role": "admin"
        }
    ]
}

This endpoint retrieves all users.

The following available filter parameter should be provided as a GET argument:

  • username (Exact match)

HTTP request

GET {{API_URL}}/api/v1/users/