Get all users

GET

/api/users

Retrieves a paginated list of users, including their profile information. The endpoint allows you to specify optional search parameters to filter and refine the results.

Query Parameters

page

number

The page number to retrieve.

Default: 1

size

number

The number of items per page.

Default: 10

filter

string

A query filter to apply when searching for users.

sort

string

Specifies the sort criteria in the 'sort_key:sort_order' format. The sort order value can be '1' for ascending and '-1' for descending. Acceptable sort key values are 'creation_time', and 'last_updated'.

Authentication

X-API-KEY

header

Required

The API key is essential for accessing MonoCloud's APIs. You can find it in the Tenant Settings section of your MonoCloud dashboard. To authenticate your requests, include this key in the request header using the following format: X-API-Key: <Your_API_Key>.

Headers

string

application/json
application/problem+json

Responses

200

Successfully retrieved users

400

Bad Request

401

Unauthorized

403

Forbidden

Request Example

Request

curl -X GET "https://<your-domain>/api/users?page=1&size=10&filter=bob&sort=creation_time:1" \
 -H "X-API-KEY: <your-api-key>" \
 -H "Accept: application/json"

Response Example

Response

200 OK

[
  {
    "emails": [
      {
        "authenticators": [
          "password",
          "email"
        ],
        "verified": true,
        "id": "6cec8047-6149-4d9b-8d99-91c83c22a9dc",
        "email": "user@example.com",
        "primary": false,
        "idps": [
          "monocloud",
          "google"
        ]
      }
    ],
    "creation_time": 1640975400,
    "phone_numbers": [
      {
        "phone": "+441514960453",
        "authenticators": [
          "password",
          "phone"
        ],
        "verified": true,
        "id": "ab66b6a2-df6b-4f9d-9eb2-5a7142984e70",
        "primary": false,
        "idps": [
          "monocloud",
          "google"
        ]
      }
    ],
    "passkeys": [
      {
        "public_key": "MIICYzCCAcygAwIBAgIBADAMQwwCgYDVQBgQD2bZEoZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMB6Vf1nYi/rO+ryMO",
        "backup_state": true,
        "user_present": true,
        "backup_eligibility": true,
        "aa_guid": "204a871f-f7c4-465c-a81f-83d7ad4d04ee",
        "name": "IPhone 15 Pro Max",
        "passkey_id": "sM5X24vn_R3YqFvk8o5Hf7l3E1fMeyKnssiAgCYxouA",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:127.0) Gecko/20100101 Firefox/127.0",
        "user_verified": true
      }
    ],
    "last_updated": 1640975400,
    "password_updated_at": 1640975400,
    "user_id": "UOtBaOybB6dTpIJNrnkRw",
    "claims": {
      "name": "John Doe",
      "given_name": "John",
      "family_name": "Doe"
    },
    "disabled": true,
    "idps": [
      {
        "provider_user_id": "79a500f9-aba6-4f03-baec-c18f4b7136ad",
        "authenticator": "google"
      }
    ],
    "username": {
      "authenticators": [
        "password"
      ],
      "id": "9082b772-dbf6-4610-a71e-05fb93c0ab73",
      "idps": [
        "monocloud",
        "google"
      ],
      "username": "username"
    },
    "has_password": true
  }
]