Skip to main content
POST
/
search
{
  "data": [
    {
      "id": "<string>",
      "entityType": "PAYMENT_METHOD",
      "properties": [
        {
          "property": "<string>",
          "value": "<string>",
          "branchId": "<string>"
        }
      ],
      "relations": [
        {
          "property": "<string>",
          "entity": "<unknown>",
          "branchId": "<string>"
        }
      ]
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Query Parameters

​
count
number
default:10

the number of items to return

​
page
number
default:1

the page to retrieve

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
​
orderBy
object
​
fields
string[]

Response

200 - application/json
​
data
object[]
required

the list of items in the page

​
pageInfo
object
required

the page info

​
totalCount
number
required

the total number of items

​
currentPage
number
required

the current page

​
totalPages
number
required

the total number of pages