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
{
"inputs": [
{
"getClaimInputRepresentation": {
"claimId": "0Z1S70000004oVfIAI"
}
}
]
}
Sample Response
[
{
"actionName": "getClaim",
"errors": null,
"isSuccess": true,
"outputValues": {
"getClaimOutputRepresentation": {
"claimDetails": {
"accountId": "001xx000003DGQyAAO",
"attributes": [
{
"apiName": "PoliceReportNumber",
"value": "SF-2025-09-13-00123"
}
],
"claimReason": "Auto accident",
"claimReasonType": "AUTO_ACCIDENT",
"claimType": "AUTO_ACCIDENT",
"lossType": "Front bumper damaged"
},
"claimId": "0Z1S70000004oVfIAI",
"contextId": "C-000123",
"expenseReserveAmount": 750.50,
"insurancePolicyId": "0e9S70000004oVfIAI",
"lossDate": "2025-07-22",
"lossReserveAmount": 5000.00,
"name": "Claim for Auto Accident",
"productCode": "AUTO-ACCIDENT"
},
"claimItemOutputs": [
{
"claimItems": [
{
"category": "Auto Physical Damage",
"claimDetails": {
"accountId": "001xx000003DGQyAAO",
"attributes": [
{
"apiName": "DamageSeverity",
"value": "Severe"
}
],
"claimReason": "Auto accident",
"claimReasonType": "AUTO_ACCIDENT",
"claimType": "AUTO_ACCIDENT",
"lossType": "Front bumper damaged"
},
"id": "0koxx000000001dEAA",
"instanceKey": "item_vehicle_bumper_01",
"name": "Damaged Front Bumper",
"productCode": "AUTO-BUMPER-SEDAN",
"insuredItemId": "02ixx0000004l5sAAA"
}
]
}
],
"claimParticipantOutputs": [
{
"claimParticipants": [
{
"id": "0kaxx000000001dEAA",
"instanceKey": "participant_driver_1",
"accountId": "001xx000003DGQyAAO",
"contactId": "003xx000003DGQyAAO",
"insurancePolicyParticipantId": "0pPxx000000001qEAA",
"roles": [
"Driver",
"Claimant"
]
}
]
}
],
"sortOrder": -1,
"version": 1
}
}
]