Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
users
v1

Retrieve User

get/api/v1/users/users/{id}/

Path parameters

idstring required

A unique integer value identifying this user.

Query parameters

jq_filtersobject

Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"

Response

idinteger
uidstring uuid
usernamestring required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

last_namestring
first_namestring
emailstring email required
is_superuserboolean

Designates that this user has all permissions without explicitly assigning them.

is_staffboolean

Designates whether the user can log into this admin site.

is_activeboolean

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

namestring
initialsstring
organizationstring nullable
photostring
permissionsobject
groupsinteger[]

The groups this user belongs to. A user will get all permissions granted to each of their groups.

Example response

{
  "is_superuser": true,
  "is_active": true,
  "is_staff": true,
  "initials": "initials",
  "last_name": "last_name",
  "photo": "photo",
  "groups": [
    6,
    6
  ],
  "uid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "permissions": "{}",
  "organization": "organization",
  "name": "name",
  "id": 0,
  "first_name": "first_name",
  "email": "email",
  "username": "username"
}