Get personal dashboard

GET 
<your-unleash-url>/api/admin/personal-dashboard

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

Responses

200

personalDashboardSchema

application/json

Schema

Schema

admins object[]required
Users with the admin role in Unleash.
Array [
idintegerrequired
The user ID.
Example: 1
namestring
The user's name.
Example: Ash Ketchum
usernamestring
The user's username.
Example: pokémaster13
imageUrlstring
Example: https://example.com/peek-at-you.jpg
emailstring
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 [
ownerTypestringrequired
The type of the owner; will always be user.
Possible values: [user]
namestringrequired
The name displayed for the user. Can be the user's name, username, or email, depending on what they have provided.
Example: User Name
imageUrlstringnullable
The URL of the user's profile image.
Example: https://example.com/image.jpg
emailstringnullable
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 [
idstringrequired
The id of the project
Example: my-project-id
namestringrequired
The name of the project
Example: My Project
healthintegerrequired
An indicator of the project's health on a scale from 0 to 100
Example: 50
memberCountintegerrequired
The number of members this project has
Example: 4
featureCountintegerrequired
The number of features this project has
Example: 10
]
flags object[]required
A list of flags a user created or favorited
Array [
namestringrequired
The name of the flag
Example: my-flag
projectstringrequired
The id of the feature project
Example: my-project-id
typestringrequired
The type of the feature flag
Example: release
]

Example (auto)

{
  "admins": [
    {
      "id": 1,
      "name": "Ash Ketchum",
      "username": "pokémaster13",
      "imageUrl": "https://example.com/peek-at-you.jpg",
      "email": "user@example.com"
    }
  ],
  "projectOwners": [
    {
      "ownerType": "user",
      "name": "User Name",
      "imageUrl": "https://example.com/image.jpg",
      "email": "user@example.com"
    }
  ],
  "projects": [
    {
      "id": "my-project-id",
      "name": "My Project",
      "health": 50,
      "memberCount": 4,
      "featureCount": 10
    }
  ],
  "flags": [
    {
      "name": "my-flag",
      "project": "my-project-id",
      "type": "release"
    }
  ]
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

404

The requested resource was not found.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/personal-dashboard' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

ResponseClear

Click the Send API Request button above and see the response here!