Skip to content

ListUsers

Request

Fetches list of active users associated with a company. User must have a valid token with required permissions.

Endpoint: GET /v1/users. Authentication: requires AuthorizationHeader bearer token unless this operation's security is changed. Required AuthMind permission/scope: admin/user (grant this scope on the API token in Admin > API Tokens; a token without it receives 403 Forbidden). Documented parameters: from, size, identifier, sort_by, order. Pagination: use from and/or size as documented. Pagination convention for this endpoint: from is a one-based page number (default 1), size is the page length (default 50, subject to this endpoint's documented maximum). Sorting: use only documented sort fields and sort-order enum values. Response parsing: inspect success; on failure inspect error, errors, or message depending on the referenced schema.

Security
AuthorizationHeader
Query
frominteger

Page number

Pagination parameter. One-based page number for this endpoint (default 1, minimum 1).

sizeinteger

Records per page. By default no of records per page is 50.

Pagination page size / maximum records to return. Respect any endpoint-specific default or maximum stated here.

identifierstring

Name or email Id of the user to search

sort_bystring

Sort by field name

Controls sorting. Use only documented enum values when provided.

Allowed values: name, email, added_date, last_login, status, ip, role.

Enum:"name""email""added_date""last_login""status""ip""role"
orderstring

Order by asc or desc

Controls sorting. Use only documented enum values when provided.

Allowed values: asc, desc.

Enum:"asc""desc"
curl -i -X GET \
  'https://apidoc.authmind.com/_mock/v1/docs/v1/users?from=0&size=0&identifier=string&sort_by=name&order=asc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Request completed successfully. See the referenced schema for the response envelope and result payload.

Bodyapplication/json
errorstring

Error message returned when the request fails. This is free-form, human-readable text intended for logging/display -- AuthMind does not define a stable, cross-endpoint error-code contract for it. Branch integration logic on the HTTP status code and the success boolean, not on the contents of this string.

resultobject(models.ListUsersOutput)

Primary response payload for this endpoint.

successboolean

Indicates whether the request was successful.

Response
{
  "error": "",
  "result": {
    "data": [ … ],
    "total": 2
  },
  "success": true
}