Quote / Insurance

Get a list of insurance types

Get a list of insurance types.

GET

/qt/insurance-types

curl --request GET \
  --url 'https://api.catch-e.com/qt/insurance-types?insurance_type_code=%3Cstring%3E&type_category=%3Cstring%3E&high_performance_flag=yes&status_flag=active&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "qt_insurance_types": [
      {
        "claim_excess": 123,
        "date": "2023-12-25",
        "high_performance_flag": "yes",
        "insurance_type_code": "<string>",
        "insurance_type_id": "<string>",
        "name": "<string>",
        "notes": "<string>",
        "type_category": "<string>"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/qt/insurance-types"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

This method requires the InsuranceTypes:Get permission to be associated with your role.

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

insurance_type_codestringquery

Optional Insurance Type Code

Maximum string length: 6

type_categorystringquery

Optional Type Category

Maximum string length: 8

high_performance_flagenum<string>query

Optional High Performance Flag

Available options: yes, no

status_flagenum<string>querydefault:active

Optional Status Flag. Default 'active'

Available options: active, inactive

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team