UserInfoOutput

Output model for user information.

Includes all input fields plus computed fields and linked data. Used when returning user data from API endpoints.

  • areaOfResponsibilityName
    Type: stringnullable
    read-only
    required
  • departmentName
    Type: stringnullable
    read-only
    required
  • directReports
    Type: array of string
    read-only
    required
  • firstName
    Type: string
    required

    First Name - User's given name or first name (required)

  • roleName
    Type: stringnullable
    read-only
    required
  • status
    Type: integer
    required

    User Status - Current status of the user account (1=ACTIVE, 2=INACTIVE, 3=PENDING, 4=EXPIRED)

  • areaOfResponsibility
    Type: integernullable

    Area of Responsibility ID - The functional area this user is responsible for. References the area_of_responsibility lookup table

  • avatarUrl
    Type: stringnullable

    Avatar URL - URL to the user's profile picture or avatar image

  • department
    Type: integernullable

    Department ID - The department this user belongs to. References the departments lookup table

  • displayName
    Type: stringnullable

    Display Name - Friendly name shown in the UI. If not provided, defaults to 'First Last'

  • email
    Type: stringnullable

    Email Address - User's primary email address. Must be unique across the account. Used for authentication and notifications

  • groupIds
    Type: array of stringnullable

    Group IDs - List of group IDs this user belongs to. Can be provided as comma-separated string or array

  • jobTitle
    Type: stringnullable

    Job Title - User's position or title within the organization

  • lastLoginAt
    Type: stringFormat: date-timenullable

    Last Login Time - Timestamp of the user's most recent login

  • lastName
    Type: stringnullable

    Last Name - User's family name or surname

  • managerId
    Type: stringnullable

    Manager ID - User ID of this user's direct manager. Must start with 'u-'. Used for organizational hierarchy

  • quotaPlan
    Type: integernullable

    Quota Plan ID - The quota/target plan assigned to this user. Determines performance metrics and goals

  • role
    Type: integernullable

    Role ID - User's role determining permissions and access levels. References the roles lookup table

  • timezone
    Type: stringnullable

    Timezone - User's timezone for scheduling and time display. IANA timezone identifier

  • userLanguage
    Type: stringnullable

    User Language - Preferred language for UI and notifications. ISO 639-1 language code