API Documentation - Version 0.3.0

List policies

Returns available policies for the account. The list is delivered page by page, with 20 entries per page.


  GET /api/policies

Parameter

Name	Type	Required	Description
page	integer	No	The page to deliver (starting with 1)

Example of request:


  curl -s -H "CS-API-KEY: <your key>" -H "Content-Type: application/json" https://api-staging.claims-online.de/api/policies?page=2

Example of response:

See Get policy


{
  "data": [
    {
      "id": "W1230042",
      "type": "policies",
      "attributes": {
        "policy_number": "W1230042",
        "begin_period": "2024-01-01",
        "end_period": "2024-12-31",
        "begin_usage_period": "2023-12-15",
        "end_usage_period": "2025-01-31",
        "in_usage_period": true,
        "currency": "EUR",
        "contract_division": "goods"
      },
      "links": {
        "self": "https://api-staging.claims-online.de/api/policies/W1230042"
      }
    },
    {
      ...
    }
  ],
  "meta":{
    "total":1,
    "per_page":20,
    "page":4,
    "total_pages":7
  },
  "links":{
    "self":"https://api-staging.claims-online.de/api/policies?page=4",
    "next":"https://api-staging.claims-online.de/api/policies?page=5",
    "prev":"https://api-staging.claims-online.de/api/policies?page=3",
    "first":"https://api-staging.claims-online.de/api/policies?page=1",
    "last":"https://api-staging.claims-online.de/api/policies?page=7"
  }
}