Skip to main content
POST
/
search
/
count
Count
curl --request POST \
  --url https://api.example.com/search/count \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityType": "PAYMENT_METHOD",
  "where": {
    "AND": [
      {
        "property": "<string>",
        "value": {
          "equals": "<string>"
        },
        "includeAllBranches": true,
        "timeZone": "UTC",
        "textSearchDepth": 0
      }
    ],
    "OR": [
      {
        "property": "<string>",
        "value": {
          "equals": "<string>"
        },
        "includeAllBranches": true,
        "timeZone": "UTC",
        "textSearchDepth": 0
      }
    ]
  },
  "includeAllBranches": true,
  "timeZone": "UTC",
  "textSearchDepth": 0
}
'
{
  "count": 123
}

Body

application/json
​
entityType
enum<string>
required
Available options:
PAYMENT_METHOD,
PAYMENT,
POLICY,
CUSTOMER,
ASSET,
INVOICE,
DOCUMENT,
SIGNATURE,
TENANT,
PRODUCT,
QUOTE,
BROKERAGE_FIRM,
CLAIM,
EXTERNAL_SERVICE,
NOTIFICATION,
PREMIUM_SCHEDULE,
CHECK,
ALERT,
DISTRIBUTION_REQUEST,
DEROGATION,
BROKERAGE_FEE
​
where
object
required
​
includeAllBranches
boolean
default:true

Search all branches regardless of their type and status. false = look only at BASE branch

​
timeZone
string
default:UTC

This timezone is used in case no offset is specified in date filters values (ex: if 2021-01-01 or 2021-01-01T00:00:00 are provided, the timezone option is used to convert it to a UTC date)

​
textSearchDepth
number
default:0

[EXPERIMENTAL] The number of relations text search filters are checked against (exponential impact on performances)

Required range: 0 <= x <= 3

Response

200 - application/json
​
count
number
required