Sign in
users

Get all users

Changed on

Returns all users in a JSON object.

get/user

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/user
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Query parameters

takenumber nullable
Example:20
skipnumber nullable
sort'created' | 'updated' | 'requests' | 'displayname' | 'usertype' | 'role'
sortDirection'asc' | 'desc'

Sort direction. When omitted, the server chooses the direction per sort field (e.g. displayname defaults to asc, requests/updated to desc).

qstring
includeIdsstring

Response

A JSON array of all users

Example response

{
  "pageInfo": {
    "page": 1,
    "pages": 10,
    "results": 100
  },
  "results": [
    {
      "id": 1,
      "email": "hey@itsme.com",
      "userType": 1,
      "createdAt": "2020-09-02T05:02:23.000Z",
      "updatedAt": "2020-09-02T05:02:23.000Z",
      "requestCount": 5
    }
  ]
}

Changes

  • 18300e954f94Revision changes
    • info

      added the new optional query request parameter sortDirection

    • info

      added the new enum value role to the query request parameter sort

    • info

      added the new enum value usertype to the query request parameter sort