Duvet DOCS
GitHub

User Resource

A user represents a person or bot on Duvet.

User Object

FieldTypeDescription
id stringThe user's UUID (v7, time-ordered)
username stringThe user's unique username
alias string?Display name override
avatar string?Avatar attachment ID
banner string?Banner attachment ID
custom stringCustom status text
flags integerUser flags bitfield (see Enums)
badges integerUser badges bitfield (see Enums)
is_bot booleanWhether the user is a bot account
email_verified booleanWhether the user's email is verified
created_at ISO 8601When the user was created
updated_at ISO 8601When the user was last updated
deleted_at string?ISO 8601 soft-delete timestamp

Fields email and password are never included in API responses or gateway events.

Current User Object

What GET /api/users/@me and PATCH /api/users/@me return: the User object plus the private fields that are only ever shown to the user themselves.

FieldTypeDescription
birthdate string?The user's birthdate
phone string?The user's phone number

Example

{
  "id": "019cf96a-3d5b-72c5-830f-75e85355d078",
  "username": "MARCROCK22",
  "alias": null,
  "avatar": "9bd6da82-c850-424b-89a0-9e4733263a45",
  "banner": "30a56bf1-b9ca-425b-bfd4-9f843e3ce45f",
  "custom": "",
  "flags": 1,
  "badges": 1,
  "is_bot": false,
  "email_verified": true,
  "created_at": "2025-10-30T00:22:21.000Z",
  "updated_at": "2026-04-06T12:00:00.000Z",
  "deleted_at": null
}