user
admin

get user (require admin privilege)

Changed on
get/w/{workspace}/users/get/{username}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/users/get/{username}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required
usernamestring required

Response

user created

emailstring required
usernamestring required
is_adminboolean required
namestring
is_super_adminboolean required
created_atstring date-time required
operatorboolean required
disabledboolean required
groupsstring[]
foldersstring[] required
folders_readstring[] required
folders_ownersstring[] required
is_service_accountboolean
non_memberboolean

True when this is a superadmin viewing a workspace they are not a member of (is_admin/role reflect the superadmin fallback, not an actual membership).

Changes