List All Products
GET/v1/products
List All Products
Request
Query Parameters
page integer
Zero based page number of the products to retrieve
size integer
Possible values: >= 1
Default value: 20
The number of products to retrieve
sort string
Possible values: [name
, friendly_name
, abbreviation
]
The field to sort results by
Header Parameters
x-api-client-id any
Either x-api-client-id
or Authorization
header must be provided.
Responses
- 200
- 401
Ok
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
content object[]required
id uuidnullable
name PolicyType
Possible values: [event-participation-cancellation-insurance
, event-host-liability
, event-host-cancellation
, pet-insurance
, shipping
, collectibles
, medsaver
, gap-medical
, regsaver
, travel
, tuition
, registration-cancellation
, ticket-refund
, renters
, season-interruption
, team-registration
, membership-insurance
]
friendly_name string
abbreviation string
description string
peril_heading string
perils string[]
descriptors string[]
promotional_header string
promotional_description string
promotional_icon string
accept_action_text string
decline_action_text string
legal_disclaimer string
privacy_policy_url string
terms_conditions_url string
additional_policy_purchase_email_message string
pageable objectrequired
order_by object[]required
ignore_case booleanrequired
direction Sort.Order.Directionrequired
Possible values: [ASC
, DESC
]
property stringrequired
ascending boolean
number int32
size int32required
sort objectrequired
order_by object[]required
ignore_case booleanrequired
direction Sort.Order.Directionrequired
Possible values: [ASC
, DESC
]
property stringrequired
ascending boolean
page_number int32
offset int64
size int32
empty boolean
number_of_elements int32
totalSize int64required
totalPages int32
{
"content": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "event-participation-cancellation-insurance",
"friendly_name": "string",
"abbreviation": "string",
"description": "string",
"peril_heading": "string",
"perils": [
"string"
],
"descriptors": [
"string"
],
"promotional_header": "string",
"promotional_description": "string",
"promotional_icon": "string",
"accept_action_text": "string",
"decline_action_text": "string",
"legal_disclaimer": "string",
"privacy_policy_url": "string",
"terms_conditions_url": "string",
"additional_policy_purchase_email_message": "string"
}
],
"pageable": {
"order_by": [
{
"ignore_case": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
],
"number": 0,
"size": 0,
"sort": {
"order_by": [
{
"ignore_case": true,
"direction": "ASC",
"property": "string",
"ascending": true
}
]
}
},
"page_number": 0,
"offset": 0,
"size": 0,
"empty": true,
"number_of_elements": 0,
"totalSize": 0,
"totalPages": 0
}
Either x-api-client-id
or Authorization
header must be provided.
Loading...