Get all dashboard users

Get a list of call the dashboard users

GET/appid-{appId}/recipe/dashboard/users

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Header parameters

ridstring

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Responses

200get a list of dashboard users

statusstring

Allowed:OK

usersobject[]

Show properties

Array of object

emailstring

userIdstring

timeCreatednumber

isSuspendedboolean

400error code 400

string

401error code 401

string

404error code 404

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

ridheadercdi-versionheaderX.Y of the X.Y.Z CDI version.

Request

curl -X GET "/appid-{appId}/recipe/dashboard/users" \
  -H "api-key: YOUR_API_KEY"

const response = await fetch("/appid-{appId}/recipe/dashboard/users", {
  method: "GET",
  headers: {
    "api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "/appid-{appId}/recipe/dashboard/users",
    headers={
        "api-key": "YOUR_API_KEY"
    },
)

Response

{
  "status": "OK",
  "users": [
    {
      "email": "[email protected]",
      "userId": "uf2323-f223r233-f23-f23-f2f32",
      "timeCreated": 16382348324,
      "isSuspended": false
    }
  ]
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"