GET
/
v1
/
users
curl --request GET \
  --url 'https://api.rootly.com/v1/users?page%5Bnumber%5D=SOME_INTEGER_VALUE&page%5Bsize%5D=SOME_INTEGER_VALUE&filter%5Bsearch%5D=SOME_STRING_VALUE&filter%5Bemail%5D=SOME_STRING_VALUE&filter%5Bcreated_at%5D%5Bgt%5D=SOME_STRING_VALUE&filter%5Bcreated_at%5D%5Bgte%5D=SOME_STRING_VALUE&filter%5Bcreated_at%5D%5Blt%5D=SOME_STRING_VALUE&filter%5Bcreated_at%5D%5Blte%5D=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&include=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
  "data": [
    {
      "id": "511",
      "type": "users",
      "attributes": {
        "name": "Hollis Will",
        "email": "juli@kuvalis-green.test",
        "phone": null,
        "phone_2": null,
        "full_name": "Hollis Will",
        "full_name_with_team": "[Walker-Koelpin] Hollis Will",
        "slack_id": null,
        "time_zone": "UTC",
        "updated_at": "2025-03-05T15:13:46.897-08:00",
        "created_at": "2025-03-05T15:13:46.897-08:00"
      },
      "relationships": {
        "email_addresses": {
          "data": [
            {
              "id": "78561901-199f-4717-b9d4-581c782fcd33",
              "type": "user_email_addresses"
            }
          ]
        },
        "phone_numbers": {
          "data": []
        },
        "devices": {
          "data": []
        }
      }
    },
    {
      "id": "510",
      "type": "users",
      "attributes": {
        "name": "Forrest Fritsch",
        "email": "napoleon.pouros@greenholt.test",
        "phone": null,
        "phone_2": null,
        "full_name": "Forrest Fritsch",
        "full_name_with_team": "[Walker-Koelpin] Forrest Fritsch",
        "slack_id": null,
        "time_zone": "UTC",
        "updated_at": "2025-03-05T15:13:49.650-08:00",
        "created_at": "2025-03-05T15:13:46.433-08:00"
      },
      "relationships": {
        "email_addresses": {
          "data": [
            {
              "id": "94e3ef1d-af4b-41ec-ae1b-0ccf37bd538e",
              "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?

Previous
Get current user
Next