Count User Profiles

Endpoint URL: {registrationDomain} /entity.count


Counts the number of user profiles in an entity type that meet the specified criterial for example, you might return the number of users who live in France of the number of users who work for Akamai.

Refer to the Registration Error Codes section for details on error codes.

Note. Having problems finding user profiles that you just created? See this article for more information. 

Respects the API Client Allow List: Yes

API Client Permissions

The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:

Yes, but only if the owner client also has the direct_access feature.


This endpoint supports both Basic authentication (recommended) and janrain-signed authentication.

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Identity Cloud Capture domain; for example:

Your Capture domains (also known as Registration domains) can be found in the Console on the Manage Application page:


Example request

This command returns a count of all the records where the user has specified their date of birth (that is, all records where the birthday attribute is not set to a null value).

curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode type_name=user \
  --data-urlencode filter='birthday is not null' \

      Running this command in Postman

Example Response

  "total_count": 15,
  "stat": "ok"

Example Error Response

  "argument_name": "filter",
  "request_id": "r6fsc52quz348mmh",
  "code": 200,
  "error_description": "filter was not valid for the following reason: Unknown attribute (null)",
  "error": "invalid_argument",
  "stat": "error"

Query Parameters

filterstringNoA query against record fields. If this parameter is not included, all records in the entity are counted. For more information on constructing queries, see entity.find.
type_namestringYesentityType where the user record is stored.