GET
/
v1
/
users
curl --request GET \
  --url https://api.rootly.com/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "521",
      "type": "users",
      "attributes": {
        "name": "Scott Fadel",
        "email": "filiberto.pouros@quigley.test",
        "phone": null,
        "phone_2": null,
        "full_name": "Scott Fadel",
        "full_name_with_team": "[Strosin and Sons] Scott Fadel",
        "slack_id": null,
        "time_zone": "UTC",
        "updated_at": "2025-03-20T17:55:26.332-07:00",
        "created_at": "2025-03-20T17:55:26.332-07:00"
      },
      "relationships": {
        "email_addresses": {
          "data": [
            {
              "id": "c32e6e2f-b2e3-4f9d-ac48-4b4aa3b6fd7d",
              "type": "user_email_addresses"
            }
          ]
        },
        "phone_numbers": {
          "data": []
        },
        "devices": {
          "data": []
        }
      }
    },
    {
      "id": "520",
      "type": "users",
      "attributes": {
        "name": "Delcie Heller",
        "email": "sanford@schultz-mcclure.example",
        "phone": null,
        "phone_2": null,
        "full_name": "Delcie Heller",
        "full_name_with_team": "[Strosin and Sons] Delcie Heller",
        "slack_id": null,
        "time_zone": "UTC",
        "updated_at": "2025-03-20T17:55:29.042-07:00",
        "created_at": "2025-03-20T17:55:25.884-07:00"
      },
      "relationships": {
        "email_addresses": {
          "data": [
            {
              "id": "64bd9df5-2d75-4950-8df7-7a5b6f580cf4",
              "type": "user_email_addresses"
            }
          ]
        },
        "phone_numbers": {
          "data": []
        },
        "devices": {
          "data": []
        }
      }
    }
  ],
  "links": {
    "self": "http://www.example.com/v1/users?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "first": "http://www.example.com/v1/users?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "prev": null,
    "last": "http://www.example.com/v1/users?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "next": null
  },
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_count": 2
  }
}

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

Response

200
application/vnd.api+json
user found
​
data
object[]
required
​
links
object
required

Was this page helpful?