Get Users

GET /v2/user

Retrieves a filtered and paginated list of users. Supports advanced query parameters such as search, sorting, tenant filtering, date filtering, population of related objects, limit, and offset. Required query parameters must be included for a valid request.

Query Parameters

• filter[tenant] - Parameter for filter[tenant]
• limit - Maximum number of items to return
• offset - Number of items to skip
• ~populate - Parameter for ~populate
• ~search - Parameter for ~search
• ~sort - Parameter for ~sort
• ~filter[created] - Parameter for ~filter[created]

Request Example

GET /v2/user?filter[tenant]=!1234&limit=5&offset=0

Response Example

{
  "data": [
    {
      "_id": "user-id-1",
      "firstname": "Example",
      "lastname": "User",
      "username": "user1@example.com",
      "factors": [
        {
          "type": "mail",
          "value": "user1@example.com",
          "_id": "factor-id-1"
        }
      ],
      "role": "admin",
      "tenant": "tenant-id-1",
      "phone": "4799999999",
      "status": {
        "active": true
      },
      "type": "user",
      "created": "2025-06-20T07:12:38.038Z",
      "updated": "2025-06-20T07:58:55.097Z",
      "metadata": {
        "last_login": "2025-06-20T07:58:55.087Z"
      }
    },
    {
      "_id": "user-id-2",
      "firstname": "Demo",
      "lastname": "Admin",
      "username": "admin@example.com",
      "factors": [
        {
          "type": "mail",
          "value": "admin@example.com",
          "_id": "factor-id-2"
        }
      ],
      "role": "admin",
      "tenant": "tenant-id-2",
      "phone": "4798888888",
      "status": {
        "active": true
      },
      "type": "user",
      "created": "2025-06-19T23:13:05.425Z",
      "updated": "2025-06-20T07:59:10.173Z",
      "metadata": {
        "last_login": "2025-06-20T07:59:10.167Z"
      }
    }
  ],
  "metadata": {
    "filter": {
      "tenant": {
        "$ne": "tenant-excluded-id"
      }
    },
    "paginator": {
      "limit": 5,
      "offset": 0,
      "total": 2
    }
  }
}