User

List User

Endpoint to list all User items

post/user/get-list

Request

Request body

limitnumber

Maximum number of items to return. Defaults to 10.

skipnumber

Number of items to skip for pagination. Defaults to 0.

Example request

{
  "query": {
    "createdAt": {
      "_type": "GreaterThan",
      "value": "2026-01-01T00:00:00.000Z"
    },
    "name": {
      "_type": "Search",
      "value": "example"
    }
  },
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "email": true,
    "newUnverifiedTemporaryEmail": true,
    "companyName": true,
    "jobRole": true
  },
  "sort": {
    "createdAt": "DESC"
  }
}

Response

Successful response

countnumber

Example response

{
  "data": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "updatedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "deletedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "version": 42,
      "name": {
        "_type": "Name",
        "value": "John Doe"
      },
      "email": {
        "_type": "Email",
        "value": "user@example.com"
      },
      "newUnverifiedTemporaryEmail": {
        "_type": "Email",
        "value": "user@example.com"
      },
      "password": "hashed_string_value",
      "isEmailVerified": true,
      "companyName": "Example short text",
      "jobRole": "CEO",
      "companySize": "1 to 10",
      "referral": "Example short text",
      "companyPhoneNumber": {
        "_type": "Phone",
        "value": "+1-555-123-4567"
      },
      "profilePictureId": "123e4567-e89b-12d3-a456-426614174000",
      "twoFactorAuthEnabled": true,
      "timezone": "Example short text",
      "isDisabled": true,
      "isBlocked": true,
      "enableTwoFactorAuth": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.