KOkontainer
Users

Returns a single user

Retrieve user

Endpoint for retrieving a user (including admins).

get/users/{user_id}

Request

Path parameters

user_idstring required

ID of User

Query parameters

relationshipsstring

Requested relationships (user_groups)

includesstring

Requested includes (user_groups)

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"
    }
  }
}

Changes

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