Skip to main content
GET
/
api
/
users
/
v1
/
users
Get all users visible to the current user
curl --request GET \
  --url https://api.example.com/api/users/v1/users \
  --header 'X-Domino-Api-Key: <api-key>'
{
  "metadata": {
    "notices": [
      "<string>"
    ],
    "requestId": "<string>",
    "limit": 123,
    "offset": 123,
    "totalCount": 123
  },
  "users": [
    {
      "avatarUrl": "<string>",
      "firstName": "<string>",
      "fullName": "<string>",
      "id": "<string>",
      "lastName": "<string>",
      "userName": "<string>",
      "companyName": "<string>",
      "email": "<string>",
      "idpId": "<string>",
      "phoneNumber": "<string>",
      "roles": [
        "<string>"
      ]
    }
  ]
}

Authorizations

X-Domino-Api-Key
string
header
required

Query Parameters

offset
integer

How many users from the start to skip. Defaults to 0.

limit
integer

Max number of users to fetch. Defaults to 10.

Response

Success

metadata
object
required
users
object[]
required