Skip to main content
GET
/
api
/
adm
/
users
Get Users
curl --request GET \
  --url https://localhost:44371/api/adm/users \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": []
}

​
Description

Queries platform users across all companies with optional filtering by email, name, active status, and other criteria. This endpoint is commonly used for user management dashboards, reporting, and administrative searches. Results are paginated to handle large user sets efficiently.

​
Input

  • Query Parameters: model (UserQueryRequest) — Filtering options including:
    • email (string, optional) — Filter by email (partial match).
    • firstName (string, optional) — Filter by first name.
    • lastName (string, optional) — Filter by last name.
    • isActive (bool, optional) — Filter by active status.
    • limit (int, optional) — Maximum records to return (default: 20).
    • offset (int, optional) — Number of records to skip for pagination.

​
Output

Returns a UserQueryResponse containing matching users or an empty list if none found.

​
Example Request

GET /api/admin/users?email=john&isActive=true&limit=20&offset=0
Authorization: Bearer {token}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Smith",
      "phoneNumber": "555-0123",
      "isActive": true,
      "createdDate": "2025-01-15T10:30:00Z"
    }
  ],
  "totalCount": 1
}

​
Errors

  • 400 Bad Request — Invalid query parameters or filter values.
  • 401 Unauthorized — Missing or invalid authentication token.
  • 403 Forbidden — User does not have permission to query users.

​
Notes

  • Passwords are never included in query results for security.
  • Results can be filtered by email (partial match), firstName, lastName, and isActive status.
  • Use offset and limit parameters for pagination through large result sets.
  • Empty result set returns success with empty entries array, not an error.
  • All timestamps are returned in ISO 8601 format with UTC timezone.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
Id
string<guid> | null

Optional identifier to filter results by a specific entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Standard query response containing a collection of matching entities. Represents a paginated response containing user query results.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null

​
entries
object[] | null

Collection of entities matching the query criteria.

Example:
[]