Users

Users are the representation of human administrators on the platform. They can become members of organizations and own spaces.

The endpoint specific to your user offers more functionality than the one generic to any user.

Access: To view a user, you must share an organization with them.

Users must not be confused with identities, which represent the people speaking on the audios uploaded to the platform.

Fields

idstringrequired

The UUID of the user. Is unique.

Format: uuid

Example: 00000000-0000-0000-0000-000000000000

handlestringrequired

The handle of the user. Is unique.

Example: user-a

aliasstring | nullrequired

The alias of the user.

Example: User A

emailstringrequired

The email of the user. Is unique.

Example: user.a@email.com

emailVerifiedboolean

Indicates whether the email of the user has been verified.

Example: true

statestringrequired

The state of the user.

Format: UserState (string)

Possible values: [verified, unverified, blocked]

Example: verified

orgsintegerrequired

The number of organizations of the user.

Format: int32

Example: 10

spacesintegerrequired

The number of spaces of the user.

Format: int32

Example: 10

createdAtstringrequired

The date and time when the user was created.

Format: date-time

Example: 2023-01-01T00:00:00.000000Z

User
{
  "id": "00000000-0000-0000-0000-000000000000",
  "handle": "user-a",
  "alias": "User A",
  "email": "user.a@email.com",
  "emailVerified": true,
  "state": "verified",
  "orgs": 10,
  "spaces": 10,
  "createdAt": "2023-01-01T00:00:00.000000Z"
}

Fields​

Fields