Sign in
Users

List Users

Changed on
get/users

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

searchstring

Search string to find users

pageinteger

Page number starting from 1

per-pageinteger

Number of items per page

Response

Retrieved

typestring

A base class to use when there is no baseclass available to fall on.

pageinteger required

The current page the pagination request is on

per_pageinteger required

The number of pages per pagination request

page_countinteger required

The total number of pages

total_countinteger required

The total number of resources matching the list request

next_pageinteger

The next page, if this on is not the last

Example response

{
  "resources": [
    {
      "username": "ladybugbot",
      "name": "Ladybug Bot",
      "description": "Beep Boop!",
      "picture": "https://avatars1.githubusercontent.com/u/38131342"
    }
  ]
}

Changes

  • e25504ef9dccRevision changes
    • breaking

      response property detail/items/loc/items/ list-of-types was widened by adding types integer to media type application/json of response 422

  • be42c3cf5190Revision changes
    • breaking

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

    • warning

      removed the optional property //// from the response with the status

    • info

      added the optional property to the response with the status