User management

Get information about current user

Route

GET /api/v1/user

Returns

JSON object containing general information about the current user and the organizations they belong to.

Name Type Description
avatar_url string URL which can be used to retrieve a visual representation of the user’s profile.
disable_document_storage boolean Flag that description if this user may only use the offline functionality of Vizzlo and will therefore not be able to use cloud stored documents as described in Document Management .
email string User’s email address
is_premium boolean Does this user have access to Vizzlo Premium functionality. This might be because the user has an active subscription a Vizzlo Personal plan or the user is member of an organization.
name string Full name of this user.
orgs array of objects List of all organisations this user is member of. (see below)
username string Actual username («slug») of the current user.

For each of the listed organizations in orgs, these properties are provided:

  • slug: Organization slug
  • name: Full name of organizatin
  • urls: Object that contains URLs:
    • endpoint: API endpoint of this specific organization
    • view: HTML endpoint for this specific organization that the user can be directed to
  • role: Role of this user within the organization. Might be admin, member, or brand_manager
Example
{
  "avatar_url": "https://www.gravatar.com/avatar/3b3ad500165706e5a60015b1d5d10769?d=retro",
  "disable_document_storage": false,
  "email": "noreply@vizzlo.com",
  "is_premium": true,
  "name": "Rob Lillack",
  "orgs": [
    {
      "slug": "acme",
      "name": "ACME Inc.",
      "urls": {
        "endpoint": "https://vizzlo.com/api/v1/orgs/acme",
        "view": "https://vizzlo.com/orgs/acme"
      },
      "role": "member"
    },
    {
      "slug": "vizzlo",
      "name": "Vizzlo GmbH",
      "urls": {
        "endpoint": "https://vizzlo.com/api/v1/orgs/vizzlo",
        "view": "https://vizzlo.com/orgs/vizzlo"
      },
      "role": "admin"
    }
  ],
  "username": "roblillack"
}