Skip to main content
GET
/
api
/
v1
/
groups
/
{group_id}
/
carrier_configurations
Get a list of all Carrier Configurations by Group
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/groups/{group_id}/carrier_configurations \
  --header 'Authorization: Bearer <token>'
[
  {
    "carrier_group_id": "9100084",
    "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16",
    "configuration": {
      "bill_groups": [
        {
          "bill_group_description": "All Members",
          "bill_group_number": 10001,
          "bill_group_status": "open"
        }
      ],
      "member_groups": [
        {
          "member_group_key": 2613038,
          "member_group_name": "MEMBERS A",
          "member_group_status": "open"
        },
        {
          "member_group_key": 2613037,
          "member_group_name": "MEMBERS B",
          "member_group_status": "open"
        }
      ],
      "policy_number": "9100084"
    },
    "group_id": "2705bb9f-3c90-4400-a4e7-0bc9d48e677c"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
group_id
string<uuid>
required

The unique identifier of the group for which you would like to view carrier configurations.

Example:

"2705bb9f-3c90-4400-a4e7-0bc9d48e677c"

Query Parameters

​
effective_date
string

The relative date on which to view the state of the record

Response

200 - application/json

Successful Response - Returns all matching Carrier Configurations

​
carrier_id
string<uuid>
required
read-only

Unique identifier of the carrier in Noyo

​
configuration
object
required
read-only

Carrier configuration details for the group

​
group_id
string<uuid>
required
read-only

Unique identifier of the group in Noyo

​
id
string<uuid>
required
read-only

Unique identifier of the group carrier configuration in Noyo

​
version
string<uuid>
required
read-only

Version of the group carrier configuration record

​
carrier_group_id
string | null
read-only

Unique identifier for the group in the carrier system

​
connection_configuration
object