Skip to main content

Userinfo

substring

User's unique identifier (id)

Example: 1VJEQAYWW54TZ5VD
emailstring

User's email (requires email scope)

Example: user@example.com
email_verifiedboolean

Whether email is verified (requires email scope)

namestring

Display name (requires profile scope)

Example: FurryUser42
avatarstringnullable

Avatar URL (requires profile scope)

groups object[]

Group memberships with details (requires groups scope). In v2, returns objects instead of just id strings.

  • Array [
  • idstring
    Example: Y6K08PEKXG9Q7ZWJ
    namestring
    Example: Information Technology
    typestring

    Possible values: [none, division, department, team, automated, root]

    Example: department
    slugstring
    Example: operations/information-technology
    levelstring

    Possible values: [member, team_lead, director, division_director]

    Example: member
    titlestringnullable
    Example: App Developer
  • ]
  • firstnamestring

    First name (requires staff.my.read scope)

    Example: John
    lastnamestring

    Last name (requires staff.my.read scope)

    Example: Doe
    birthdatestring<date>nullable

    Date of birth (requires staff.my.read scope)

    Example: 1990-01-15
    phonestringnullable

    Phone number (requires staff.my.read scope)

    telegram_usernamestringnullable

    Telegram username (requires staff.my.read scope)

    spoken_languagesstring[]nullable

    Spoken languages (requires staff.my.read scope)

    credit_asstringnullable

    Preferred credit name (requires staff.my.read scope)

    nda_verifiedboolean

    NDA verification status (requires staff.my.read scope)

    Userinfo
    {
    "sub": "1VJEQAYWW54TZ5VD",
    "email": "user@example.com",
    "email_verified": true,
    "name": "FurryUser42",
    "avatar": "string",
    "groups": [
    {
    "id": "Y6K08PEKXG9Q7ZWJ",
    "name": "Information Technology",
    "type": "department",
    "slug": "operations/information-technology",
    "level": "member",
    "title": "App Developer"
    }
    ],
    "firstname": "John",
    "lastname": "Doe",
    "birthdate": "1990-01-15",
    "phone": "string",
    "telegram_username": "string",
    "spoken_languages": [
    "string"
    ],
    "credit_as": "string",
    "nda_verified": true
    }