Skip to main content
GET
/
users
List Users
curl --request GET \
  --url https://api.example.com/users
{
  "data": [
    {
      "id": "<string>",
      "entity": "user",
      "broker": "WORKOS",
      "broker_id": "<string>",
      "email": "<string>",
      "name": "<string>",
      "version": 1,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "picture": "<string>",
      "email_verified": false,
      "roles": [
        "<string>"
      ]
    }
  ],
  "nextPage": {
    "cursor": "<string>",
    "limit": 123
  },
  "previousPage": {
    "cursor": "<string>",
    "limit": 123
  }
}

Query Parameters

cursor
string
limit
integer
Required range: 1 <= x <= 200
email
string

Response

200 - application/json

A list of users

data
object[]
required
nextPage
object
previousPage
object