Get Entities Total
The Get Entities Total API returns the total count of entities matching the specified criteria.
Request - You can use one of the following endpoints to search for the total count of entities:
GET {TenantURL}/entities/_totalPOST {TenantURL}/entities/_total
Note: Reltio recommends that you use the
POST method and pass the parameters through
the request body.| Parameter | Required | Description | |
|---|---|---|---|
| Headers |
Authorization
|
Yes | Information about authentication access token in format "Bearer
<accessToken>" (see details in Authentication API ). |
| Query |
filter
|
No | Enables entities filtering by a condition. Format for filter query
parameter: filter=({Condition Type}[AND/OR {Condition Type}]*)
For more information see Filtering Entities. |
activeness |
No | The possible values of this parameter are as follows:
|
|
Body (Only for the POST
method) |
No | Indicates the JSON body that can have all the same fields as
supported in the query parameters. Note: The query parameters have
priority and override the body parameters. |
|
Response
JSON object with the total number of records matching the search filter.
GET and POST Requests
GET Request (Find Total Count of Individual Entities
GET {TenantURL}/entities/_total?filter=(equals(type,'configuration/entityTypes/Individual'))
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512Response
{ "total": 528435326}POST Request (Find Total Count of Active and Not Active
Organizations
POST {TenantURL}/entities/_total
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
{
"filter": "(equals(type,'configuration/entityTypes/Organization'))",
"activeness": "all"
}Response
{ "total": 1658}