Querying for ClaimContacts

Use the following endpoints to query for ClaimContact information:

  • GET /claim/v1/claims/{claimId}/contacts
  • GET /claim/v1/claims/{claimId}/contacts/{contactId}

For example, the following request queries for all ClaimContacts on claim demo_sample:1. The request returns only the display name, id, and roles of each contact:

Command

GET /claim/v1/claims/demo_sample:1/contacts?fields=displayName,id,roles
Java

Response body

{
    "count": 7,
    "data": [
        {
            "attributes": {
                "displayName": "Mike's Auto detailing shop",
                "id": "cc:5",
                "roles": [
                    {
                        "active": true,
                        "relatedTo": {
                            "displayName": "235-53-365870",
                            "id": "demo_sample:1",
                            "type": "Claim",
                            "uri": "/claim/v1/claims/demo_sample:1"
                        },
                        "role": {
                            "code": "servicerequestspecialist",
                            "name": "Service Vendor"
                        }
                    }
                ]
            }
        },
        {
            "attributes": {
                "displayName": "Karen Egertson",
                "id": "cc:2",
                "roles": [
                    {
                        "active": true,
                        "relatedTo": {
                            "displayName": "54-123456",
                            "id": "demo_sample:1",
                            "type": "Policy",
                            "uri": "/claim/v1/claims/demo_sample:1/policy"
                        },
                        "role": {
                            "code": "agent",
                            "name": "Agent"
                        }
                    }
                ]
            }
        },
        ...
Java

ClaimContact role owners

There is also a /claim/v1/claims/{claimId}/contact-role-owners endpoint, which returns all objects on the claim that can have ClaimContacts associated with them. This includes:

  • The claim itself
  • The policy
  • Any existing incidents
  • Any existing exposures
  • Any existing service requests
  • Any existing matters (A matter is a collection of information pertaining to a lawsuit or potential lawsuit.)
  • Any existing negotiations (A negotiation is a history of the offers and counter-offers related to one disputed aspect of the loss.)
Be aware that the /claims/{claimId}/contact-role-owners endpoint returns the objects that are able to have associated ClaimContacts. These objects may or may not have ClaimContacts already associated with them. If there are ClaimContacts associated with them, the ClaimContacts are not included in the response.