Get Claim Action

Get the details of a claim.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/getClaim

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
`getClaimInputRepresentation`	Apex-defined	Required. An Apex ConnectApi.GetClaimInputRepresentation record that contains the details of the claim to be retrieved.

Outputs

Output	Type	Description
`getClaimOutputRepresentation`	Apex-defined	An Apex ConnectApi.GetClaimOutputRepresentation record that contains the details of the claim that’s retrieved.
`claimItemOutputs`	Apex-defined	A collection of Apex ConnectApi.ClaimItemOutputs records that contain the list of claim items.
`claimParticipantOutputs`	Apex-defined	A collection of Apex ConnectApi.ClaimParticipantOutputs records that contain the list of claim participants.

Example

Sample Request

1{
2  "inputs": [
3    {
4      "getClaimInputRepresentation": {
5        "claimId": "0Z1S70000004oVfIAI"
6      }
7    }
8  ]
9}

Sample Response

1[
2  {
3    "actionName": "getClaim",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": {
7      "getClaimOutputRepresentation": {
8        "claimDetails": {
9          "accountId": "001xx000003DGQyAAO",
10          "attributes": [
11            {
12              "apiName": "PoliceReportNumber",
13              "value": "SF-2025-09-13-00123"
14            }
15          ],
16          "claimReason": "Auto accident",
17          "claimReasonType": "AUTO_ACCIDENT",
18          "claimType": "AUTO_ACCIDENT",
19          "lossType": "Front bumper damaged"
20        },
21        "claimId": "0Z1S70000004oVfIAI",
22        "contextId": "C-000123",
23        "expenseReserveAmount": 750.50,
24        "insurancePolicyId": "0e9S70000004oVfIAI",
25        "lossDate": "2025-07-22",
26        "lossReserveAmount": 5000.00,
27        "name": "Claim for Auto Accident",
28        "productCode": "AUTO-ACCIDENT"
29      },
30      "claimItemOutputs": [
31        {
32          "claimItems": [
33            {
34              "category": "Auto Physical Damage",
35              "claimDetails": {
36                "accountId": "001xx000003DGQyAAO",
37                "attributes": [
38                  {
39                    "apiName": "DamageSeverity",
40                    "value": "Severe"
41                  }
42                ],
43                "claimReason": "Auto accident",
44                "claimReasonType": "AUTO_ACCIDENT",
45                "claimType": "AUTO_ACCIDENT",
46                "lossType": "Front bumper damaged"
47              },
48              "id": "0koxx000000001dEAA",
49              "instanceKey": "item_vehicle_bumper_01",
50              "name": "Damaged Front Bumper",
51              "productCode": "AUTO-BUMPER-SEDAN",
52              "insuredItemId": "02ixx0000004l5sAAA"
53            }
54          ]
55        }
56      ],
57      "claimParticipantOutputs": [
58        {
59          "claimParticipants": [
60            {
61              "id": "0kaxx000000001dEAA",
62              "instanceKey": "participant_driver_1",
63              "accountId": "001xx000003DGQyAAO",
64              "contactId": "003xx000003DGQyAAO",
65              "insurancePolicyParticipantId": "0pPxx000000001qEAA",
66              "roles": [
67                "Driver",
68                "Claimant"
69              ]
70            }
71          ]
72        }
73      ],
74      "sortOrder": -1,
75      "version": 1
76    }
77  }
78]