Logo carlschroeter header
Claims Online
Schäden online melden

API Documentation - Version 0.3.0

List claims

Returns claims. The list is delivered page by page, with 20 entries per page.

GET /api/claims

Parameter

Name Type Required Description
policy_id ID Yes The policy ID to which the claims are to be delivered, e.g. W1230042. Several policy IDs can be specified separated by commas.
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://www.claims-online.de/api/claims?policy_id=X8J7UY&page=4

Example of response:

See Get claim

{
  "data": [
    ...
  ],
  "included": [
    ...
  ],
  "meta":{
    "total":1,
    "per_page":20,
    "page":4,
    "total_pages":7
  },
  "links":{
    "self":"https://www.claims-online.de/api/claims?page=4",
    "next":"https://www.claims-online.de/api/claims?page=5",
    "prev":"https://www.claims-online.de/api/claims?page=3",
    "first":"https://www.claims-online.de/api/claims?page=1",
    "last":"https://www.claims-online.de/api/claims?page=7"
  }
}