improved

Extended List of Claim Attributes

When fetching claims from our API we now return more metadata about the claim record in the JSON response.

This expanded list of attributes includes the following new data:

AttributeDescriptionExample
opened_atA timestamp showing when the claim status was last changed to open.'2023-07-01T09:25:17Z'
closed_atA timestamp showing when the claim status was last changed to closed.'2023-09-11T10:45:12Z'
claim_durationThe elapsed time in days since the claim was created to the current date, if the claim is open, or until closed_at, if the claim is closed.42
assigned_atWhen the claim was assigned to the assigned_to user.'2023-09-11T10:45:12Z'
total_reserveThe sum of all reserves, in cents/pennies.200000
total_paidThe sum of all payments, in cents/pennies.100000
outstanding_reserveThe difference between the total reserve and total paid, in cents/pennies.100000
last_activity_atA timestamp showing when the most recent activity was performed on the claim.'2023-09-11T10:45:12Z'
last_activity_keyA string that represents what the most recent activity is.'claim.note.create'
last_activity_descriptionA description of the most recent activity.'Created note'
conversations_countThe number of all conversations on the claim.13
open_conversations_countThe number of open conversations on the claim.3
closed_conversations_countThe number of closed conversations on the claim.10
tasks_countThe number of all tasks on the claim.7
outstanding_tasks_countThe number of open tasks on the claim.2
completed_tasks_countThe number of completed tasks on the claim.5
status_changed_byThe ID of the user who last changed the claim status.1234
last_activity_byThe ID of the user who performed the last activity on the claim.1234

Read more about the claims endpoints in our API reference.

Claims