Count bulk import users

Count users in the bulk import processing queue, by status or all of them (by passing null status).

GET/appid-{appId}/bulk-import/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

appIdstringrequired

The application ID. Omit the entire `appid-{appId}` prefix to use `public`.

Query parameters

statusbulkImportUserStatus

Allowed:NEWPROCESSINGFAILED

Header parameters

cdi-versionstring

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

Responses

200The number of users in the bulk import processing queue by status

statusstatusOK

Allowed:OK

countnumber

The number of users in the bulk import processing queue by status

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

appIdpath*The application ID. Omit the entire `appid-{appId}` prefix to use `public`.cdi-versionheaderX.Y of the X.Y.Z CDI version.statusquery

Request

curl -X GET "/appid-public/bulk-import/users/count" \
  -H "api-key: YOUR_API_KEY"

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

import requests

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

Response

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

"string"

"Invalid API key"

"Not Found"

"Internal Error"