TulipTulip Docs
Sinistres

Lister les sinistres

Ce endpoint permet de récupérer la liste des sinistres d'un utilisateur avec pagination.

GET
/claims
key<token>

In: header

Query Parameters

userId*string

L'identifiant unique de l'utilisateur

status?string

Le filtre de statut pour la liste des sinistres.

  • draft: Pré-déclarations en cours
  • submitted: Sinistres soumis et en traitement
  • cancelled: Sinistres annulés/abandonnés
Value in"draft" | "submitted" | "cancelled"
limit?number

Le nombre de résultats à retourner

offset?number

Le nombre de résultats à ignorer

Response Body

application/json

application/json

application/json

curl -X GET "https://api.mytulip.io/v2/claims?userId=A1234567890"
{
  "success": true,
  "data": [
    {
      "id": "claim_xyz789",
      "claimId": "claim_xyz789",
      "status": "draft",
      "canSubmit": false,
      "type": "theft",
      "subtype": "total_theft",
      "claimAt": "2024-01-15T14:30:00Z",
      "contractId": "contract_abc123",
      "contractProductId": "product_def456",
      "createdAt": "2024-01-16T10:00:00Z",
      "updatedAt": "2024-01-16T10:00:00Z"
    }
  ],
  "pagination": {
    "total": 0,
    "offset": 0,
    "limit": 0
  }
}
{
  "success": false,
  "error": {
    "code": 0,
    "message": "string"
  }
}
{
  "success": false,
  "error": {
    "code": 0,
    "message": "string"
  }
}

Que pensez-vous de cette page ?