Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Product Administration
Insurance Quoting
Insurance Policy Administration
Insurance Policy Business APIs
Resources
Cancel Insurance Policy (POST)
Endorse Insurance Policy (POST)
Insurance Policy Details (GET)
Issue Insurance Policy (POST)
Renew Insurance Policy (POST)
Requests
Responses
Insurance Policy Standard Invocable Actions
Insurance Policy Administration Metadata API Types
Insurance Brokerage
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Insurance Policy Details (GET)

Get the context ID and the insurance policy details. This includes related assets, participants, and coverages. Use query parameters to request additional information.
Resource
1/connect/insurance/policies/policyId?_qs=contextOnly=true
1/connect/insurance/policies/policyId?_qs=expand[attributes]=true
1/connect/insurance/policies/policyId?_qs=expand[attributes]=true&expand[surcharges]=true
1/connect/insurance/policies/policyId?_qs=expand[additionalFields][fieldSet][$in]={fieldSetIds}
1/connect/insurance/policies/policyId?_qs=expand[additionalFields][fieldSet][$eq]={fieldSetId}
1/connect/insurance/policies/policyId?_qs=expand[additionalFields][fieldSet][$eq]={fieldSetId};contextOnly=true
1/connect/insurance/policies/policyId?_qs=expand[additionalFields][fieldSet][$eq]={fieldSetId};expand[attributes]=true
1/connect/insurance/policies/policyId?_qs=expand[additionalFields][fieldSet][$eq]={fieldSetId};expand[attributes]=true&expand[surcharges]=true
Resource example
1https://yourInstance.salesforce.com/services/data/v63.0/connect/insurance/policies/0YTxx0000000001GAA
1https://yourInstance.salesforce.com/services/data/v63.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[attributes]=true
1https://yourInstance.salesforce.com/services/data/v63.0/connect/insurance/policies/0YTxx0000000001GAA?_qs=expand[attributes]=true&expand[surcharges]=true
1https://yourInstance.salesforce.com/services/data/v63.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=contextOnly=true
1https://yourInstance.salesforce.com/services/data/v63.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[additionalFields][fieldSet][$in]=0IXSG000001ADt34AG,0IXSG000001AUp34AG
1https://yourInstance.salesforce.com/services/data/v63.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[additionalFields][fieldSet][$in]=0IXSG000001ADt34AG,0IXSG000001AUp34AG;contextOnly=true
1https://yourInstance.salesforce.com/services/data/v63.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[additionalFields][fieldSet][$in]=0IXSG000001ADt34AG,0IXSG000001AUp34AG;expand[attributes]=true
1https://yourInstance.salesforce.com/services/data/v63.0/connect/insurance/policies/0YTxx0000000001GAA?_qs=expand[surcharges]=true
Available version
63.0
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
connectDynamicParameters Map<String,String> Map of connect dynamic parameters. Optional 63.0
Response body for GET
Get Policy