Get users count

Get number of users.

API is tenant specific if includeAllTenants is false. Else, tenantId is ignored.

GET/appid-{appId}/{tenantId}/users/count

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.

Path parameters

tenantIdstring

The tenant against which the request is made. If left empty, the default tenant will be used.

Query parameters

includeRecipeIdsstring

The param should take an array of comma seperated strings

includeAllTenantsboolean

if set to true, will count users across all tenants in the app

default: false

Header parameters

cdi-versionstring

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

Responses

200Get number of users

statusstatusOK

Allowed:OK

countnumber

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

tenantIdpath*The tenant against which the request is made. If left empty, the default tenant will be used.cdi-versionheaderX.Y of the X.Y.Z CDI version.includeRecipeIdsqueryThe param should take an array of comma seperated stringsincludeAllTenantsqueryif set to true, will count users across all tenants in the app

Request

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

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

import requests

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

Response

{
  "status": "OK",
  "count": 1000000
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"