Menu
Open source
Get a user
This endpoint retrieves the user object.
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",
"timezone": "UTC"
}
HTTP request
GET {{API_URL}}/api/v1/users/<USER_ID>/
Use {{API_URL}}/api/v1/users/current
to retrieve the current user.
Parameter | Unique | Description |
---|---|---|
id | Yes/org | User ID |
email | Yes/org | User e-mail |
slack | Yes/org | List of user IDs from connected Slack. User linking key is e-mail. |
username | Yes/org | User username |
role | No | One of: user , observer , admin . |
timezone | No | timezone of the user one of time zones. |
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",
"timezone": "UTC"
}
],
"current_page_number": 1,
"page_size": 100,
"total_pages": 1
}
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/
Was this page helpful?
Related resources from Grafana Labs
Additional helpful documentation, links, and articles:

Getting started with Grafana OnCall for on-call management (APAC Timezone)
This webinar goes over initial Grafana OnCall configuration, setting up an on-call management process, grouping, alert rendering, and organizing runbooks.

Unified alerting and on-call management in Grafana
In this webinar, we’ll demo the Grafana 8 unified alerting system, and introduce Grafana OnCall, our on-call management tool to resolve incidents faster.

Reducing resolution time (MTTR) with the Grafana LGTM Stack and on-call management
See a demo of Grafana OnCall, and how to correlate your metrics, logs, and traces to reduce your MTTR using Grafana’s “single pane of glass” approach.