KOkontainer
Users

Returns a list of all users including admins

Retrieve Users

Endpoint for retrieving a collection of Users (this includes admins).

get/users

Request

Query parameters

relationshipsstring

Requested relationships (user_groups)

includesstring

Requested includes (user_groups)

page[size]integer

Define the per page size. (defaults to 100, limit is 500) Example: page[size]=10

page[number]integer

Define the page number. (defaults to 1) Example: page[number]=1

Response

success

Example response

{
  "data": [
    {
      "id": "55211",
      "type": "user",
      "attributes": {
        "name": "John Doe",
        "username": "john.doe@email.com",
        "email": "john.doe@email.com",
        "active": true,
        "last_login": "2023-10-01T12:00:00.000000Z",
        "status": "verified",
        "is_client_admin": true,
        "signature": "Kind regards, John",
        "company": "John's Company",
        "expires": "2023-12-31 23:59:59",
        "type": "normal",
        "user_type": "SINGLE",
        "can_create_lightbox": true,
        "can_edit_profile": true,
        "show_brand_section": true,
        "hide_menu_by_default": true,
        "custom_metadata": "Custom metadata for the user",
        "internal_metadata": "Internal metadata for the user"
      }
    }
  ],
  "links": {
    "first": "https://kontainer.test/jsonapi/v2/users?page=1",
    "last": "https://kontainer.test/jsonapi/v2/users?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "Previous",
        "active": false
      },
      {
        "url": "https://kontainer.test/jsonapi/v2/users?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next",
        "active": false
      }
    ],
    "path": "https://kontainer.test/jsonapi/v2/users",
    "per_page": 100,
    "to": 26,
    "total": 26
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.