Count user profiles

Counts the number of user profiles in an entity type that meet the specified search 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 page for details on error codes.

API client permissions

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



This operation supports both Basic authentication (recommended) and janrain-signed authentication. See Get started for more information.

Base URL

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

Your Capture domain (also known as a Registration domain) can be found in Console on the Manage Application page.


Example request: Return users who have specified their date of birth

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 isn't set to a null value):

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

Example response

If your API call succeeds, you'll get back the total number of records that meet the search criteria:

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

Example error response

If your API call doesn't succeed, you'll get back an error message similar to this:

  "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"

See Registration error codes for more information about these error codes. Note that the Entity and Entity Type API doesn't use standard HTTP error codes.


All parameters need to be configured as x-www-form-urlencoded body parameters.

filterstringProvides a way to limit the API response to records that meet the specified search criteria. If this parameter isn't included, all records in the entity are counted.

For more information on constructing search queries, see Search for user profiles.
type_namestringEntity type containing the user profiles you're searching.