Skip to main content

Get personal dashboard

GET 

/api/admin/personal-dashboard

Return all projects and flags that are relevant to the user.

Responses

personalDashboardSchema

Schema

    admins

    object[]

    required

    Users with the admin role in Unleash.

  • Array [

  • id integerrequired

    The user ID.

    Example: 1
    name string

    The user's name.

    Example: Ash Ketchum
    username string

    The user's username.

    Example: pokémaster13
    imageUrl string
    Example: https://example.com/peek-at-you.jpg
    email string
    Example: user@example.com
  • ]

  • projectOwners

    object[]

    required

    Users with the project owner role in Unleash. Only contains owners of projects that are visible to the user.

  • Array [

  • ownerType stringrequired

    The type of the owner; will always be user.

    Possible values: [user]

    name stringrequired

    The name displayed for the user. Can be the user's name, username, or email, depending on what they have provided.

    Example: User Name
    imageUrl stringnullable

    The URL of the user's profile image.

    Example: https://example.com/image.jpg
    email stringnullable

    The user's email address.

    Example: user@example.com
  • ]

  • projects

    object[]

    required

    A list of projects that a user participates in with any role e.g. member or owner or any custom role

  • Array [

  • id stringrequired

    The id of the project

    Example: my-project-id
    name stringrequired

    The name of the project

    Example: My Project
    health integerrequired

    An indicator of the project's health on a scale from 0 to 100

    Example: 50
    memberCount integerrequired

    The number of members this project has

    Example: 4
    featureCount integerrequired

    The number of features this project has

    Example: 10
  • ]

  • flags

    object[]

    required

    A list of flags a user created or favorited

  • Array [

  • name stringrequired

    The name of the flag

    Example: my-flag
    project stringrequired

    The id of the feature project

    Example: my-project-id
    type stringrequired

    The type of the feature flag

    Example: release
  • ]

Loading...