ARarchives
Accounts

Get public account data directly from the database

Changed on

Provide any combination of the parameters below to return all users that match this criteria. Use asterisks for wildcards. Values are NOT case sensitive.

get/users

Request

Query parameters

userIdstring

User id of the user account.

emailstring

Email address of the user account.

userNamestring

Username of the user account.

fullNamestring

Full name of the user account.

rolestring

Role of the user account.

status'active' | 'deactivated'

Status of the user account.

limitinteger

Number of records to be returned on a page. Defaults to 5.

pageinteger

Page number of records to display. Defaults to 1.

sortColstring

Column name to sort the results by. Optional.

sortOrder'asc' | 'desc'

Sort order, ascending or descending. Defaults to "asc" if not specified.

Response

A body of response data containing user records from the database that match search criteria.

criteriaobject

Changes

  • 9686559b9a2aRevision changes
    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status