Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Group Benefits
Insurance Policy Administration
Insurance Policy Business APIs
Resources
Cancel Insurance Policy (POST)
Endorse Insurance Policy (POST)
Insurance Policy Details (GET)
Issue Insurance Policy (POST)
Out-of-Sequence Endorse Policy (POST)
Reinstate Insurance Policy (POST)
Renew Insurance Policy (POST)
Multi-Root Policy Issuance (POST)
Multi-Root Policy Endorsement (POST)
Multi-Root Policy Renewal (POST)
Requests
Responses
Insurance Policy Standard Invocable Actions
Insurance Policy Administration Metadata API Types
Insurance Policy Standard Objects
Insurance Policy Administration Apex Reference
Insurance Policy Developer Journey
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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/v68.0/connect/insurance/policies/0YTxx0000000001GAA
1https://yourInstance.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[attributes]=true
1https://yourInstance.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx0000000001GAA?_qs=expand[attributes]=true&expand[surcharges]=true
1https://yourInstance.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=contextOnly=true
1https://yourInstance.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[additionalFields][fieldSet][$in]=0IXSG000001ADt34AG,0IXSG000001AUp34AG
1https://yourInstance.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[additionalFields][fieldSet][$in]=0IXSG000001ADt34AG,0IXSG000001AUp34AG;contextOnly=true
1https://yourInstance.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[additionalFields][fieldSet][$in]=0IXSG000001ADt34AG,0IXSG000001AUp34AG;expand[attributes]=true
1https://yourInstance.salesforce.com/services/data/v68.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