Skip to main content

Gets the detailed user list

GET /v1/user/detail/list

Summary​

Gets the detailed user list.

Details​

This endpoint is restricted to admin users.

Authentication​

No operation-level security requirement is documented here.

Parameters​

None documented here.

Request Body​

No request body is documented here.

Responses​

200​

Success

application/json​

  • array of User
    • key (integer (int64), optional)
    • userTypeID (integer (int64), optional)
    • username (string, optional)
    • emailAddress (string, optional)
    • passwordStrength (integer (int64), optional)
    • verificationToken (string, optional)
    • verificationTokenExpiration (string (date-time), optional)
    • refreshData (string (date-time), optional)
    • userStatusID (integer (int64), optional)
    • passwordResetToken (string, optional)
    • passwordResetTokenExpiration (string (date-time), optional)
    • lastInvalidLoginAttemptDate (string (date-time), optional)
    • lastLoginAttemptDate (string (date-time), optional)
    • invalidLoginAttempts (integer (int64), optional)
    • timeZone (string, optional)
    • firstName (string, optional)
    • lastName (string, optional)
    • description (string, optional)
    • availability (string, optional)
    • creationDate (string (date-time), optional)

Example

[
  {
    "key": 101,
    "userTypeID": 1,
    "username": "testuser",
    "emailAddress": "testuser@actionstreamer.com",
    "passwordStrength": 4,
    "verificationToken": "example-token",
    "verificationTokenExpiration": "2026-03-30T12:00:00.0000000Z",
    "refreshData": "2026-03-30T12:00:00.0000000Z",
    "userStatusID": 1,
    "passwordResetToken": "example-token",
    "passwordResetTokenExpiration": "2026-03-30T12:00:00.0000000Z",
    "lastInvalidLoginAttemptDate": "2026-03-30T12:00:00.0000000Z",
    "lastLoginAttemptDate": "2026-03-30T12:00:00.0000000Z",
    "invalidLoginAttempts": 1,
    "timeZone": "America/New_York",
    "firstName": "Test",
    "lastName": "User",
    "description": "Example description",
    "availability": "Available",
    "creationDate": "2026-03-30T12:00:00.0000000Z"
  }
]