Get all customer policies

GET 
/v1/rates/customer-policies

Get all customer policies

Request

Query Parameters

page number

Possible values: >= 1

Default value: 1

Page number for pagination

limit number

Possible values: >= 1

Default value: 10

Number of items per page

name string

Filter by customer policy name (case-insensitive)

Responses

200

List of customer policies

application/json

Schema

Schema

data object[]required
The data of the paginated response
Array [
_id stringrequired
name stringrequired
isDefault boolean
Whether the customer policy is the default policy
latestUpdate date-time
]
total numberrequired

The total number of items

page numberrequired

The current page

limit numberrequired

The number of items per page

totalPages numberrequired

The total number of pages

Example (from schema)

{
  "data": [
    {
      "_id": "string",
      "name": "Standard Customer Policy",
      "isDefault": false,
      "latestUpdate": "2024-07-29T15:51:28.071Z"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

400

Invalid input data

500

Internal server error

Loading...