Quote Groups

Get a quote group

GET
/partnerapi/v2/quote-groups/{quoteGroupId}

Returns the current state of a quote group — quotes and per-type errors.

Authorization

partnerApiKey
X-SwyfftApiKey<token>

API key issued by Swyfft. Pass in the X-SwyfftApiKey request header.

In: header

Path Parameters

quoteGroupId*string

ID of the quote group returned by Create a quote group.

Response Body

curl -X GET "https://example.com/partnerapi/v2/quote-groups/string"
{  "quoteGroupId": "a51b0373-35ef-4927-98a1-cbda0d27b588",  "quotes": [    {      "quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7",      "ratingType": "Admitted",      "carrierCode": "BIC",      "annualPremium": 1250,      "annualFeesTotal": 100,      "grossAnnualPayment": 100,      "expiresOn": "2025-06-15T14:30:00Z",      "customizeUrl": "string",      "premiumErrors": "1250.00",      "elementGroups": [        {          "groupName": "string",          "elements": [            {              "elementName": "string",              "value": "1000.00",              "defaultValue": "1000.00",              "elementType": "string",              "valueType": "1000.00",              "editable": true,              "conditionallyHidden": true,              "displayFormat": "string",              "minValue": 1000,              "maxValue": 1000,              "increment": 100,              "choices": [                {                  "name": "John Smith",                  "value": "1000.00"                }              ]            }          ]        }      ]    }  ],  "errors": [    {      "ratingType": "Admitted",      "code": "conflict",      "message": "string"    }  ],  "createdOn": "2025-06-15T14:30:00Z"}