Skip to main content
GET
/
api
/
v1
/
group_connections
/
{connection_id}
Get a single Group Connection
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/group_connections/{connection_id} \
  --header 'Authorization: Bearer <token>'
{
  "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
  "completed": 1557392400,
  "created": 1557329939,
  "group_data": {
    "carrier_group_id": "10000000",
    "group_name": "Test Company"
  },
  "group_id": "9e629e41-c706-4efd-9fbb-1ff2573fc67e",
  "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1",
  "modified": 1557392400,
  "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e",
  "request_type": "initial",
  "setup_result": {},
  "status": "completed",
  "version": "9906b5d2-e76d-4bad-ba4c-8ce90b6b867b"
}

Documentation Index

Fetch the complete documentation index at: https://docs.noyo.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the latest status of a single group connection based on the ID provided.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
connection_id
string<uuid>
required

The unique identifier of the group connection you would like to view

Example:

"dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1"

Response

200 - application/json

Successful Response - Returns a single Group Connection

​
carrier_id
string<uuid>
required
read-only

Unique identifier of the carrier in Noyo

​
created
integer
required

The date the record was created

​
group_data
object
required

Carrier-specific data to execute a group connection

​
id
string<uuid>
required
read-only

Unique identifier of the group connection in Noyo

​
modified
integer
required

The date the record was last updated

​
organization_id
string<uuid>
required
read-only

Unique identifier of the platform or broker organization in Noyo

​
request_type
string
required
read-only

Type of the group connection

​
setup_result
object
required
read-only

More information about the result of the group connection

​
status
enum<string>
required
read-only

Status of the group connection

Available options:
created,
processing,
noyo_review,
waiting_on_carrier,
carrier_authorization,
action_required,
unable_to_connect,
completed
​
version
string<uuid>
required

Current version of the record

​
completed
integer
read-only

Timestamp indicating when a group connection was marked as completed.

​
federal_ein
string
read-only

Federal Employer Identification Number for the group

​
group_id
string<uuid>
read-only

ID of associated group model