Skip to main content
GET
/
v1
/
users
List users
curl --request GET \
  --url https://api.rootly.com/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "users",
      "attributes": {
        "email": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "full_name": "<string>",
        "full_name_with_team": "<string>",
        "time_zone": "<string>"
      },
      "relationships": {
        "role": {
          "data": {
            "id": "<string>",
            "type": "roles"
          }
        },
        "on_call_role": {
          "data": {
            "id": "<string>",
            "type": "on_call_roles"
          }
        }
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page[number]
integer
​
page[size]
integer
​
filter[search]
string
​
filter[email]
string
​
filter[created_at][gt]
string
​
filter[created_at][gte]
string
​
filter[created_at][lt]
string
​
filter[created_at][lte]
string
​
sort
enum<string>

comma separated if needed. eg: created_at,updated_at

Available options:
created_at,
-created_at,
updated_at,
-updated_at
​
include
enum<string>

comma separated if needed. eg: email_addresses,phone_numbers

Available options:
email_addresses,
phone_numbers,
devices,
role,
on_call_role,
teams,
schedules,
notification_rules

Response

user found

​
data
object[]
required
​
links
object
required