User objects returned from the endpoints adhere to the following specification.

Attribute

Type

Description

id

string (uuid)

A unique identifier for the user. Used primarily towards other APIs when you wish to reference a specific user. This value is read-only

email

string

The email representing the user. This is a verified contact point for the user. This value is read-only

displayName

string

The name of the user, as the user wishes to be addressed.

username

string

The short human-friendly identifier for the user, used for linking directly to a user in the url.

title

string

The title of the user, as the user wishes to present it.

avatarUrl

string

A link to the user supplied profile picture.

isPubliclyVisible

boolean

A value representing if the user is shown on the frontpage or not.

organizationId

string (uuid)

A unique identifier to the organization the user belongs to.

role

string

The role of the user, should there be difference in access granted.

{
  id: "1316a668-74ee-4912-8c9e-d6563e704582",
  email: "[email protected]",
  displayName: "Janelle Williams",
  username: "janelle",
  title: "CEO",
  avatarUrl: "https://via.placeholder.com/150x150",
  isPubliclyVisible: true,
  organizationId: "0c1022d3-ac83-4bad-8db5-faeacb7507ee",
  role: "professional"
}