Skip to main content
GET
/
api
/
v1
/
group_connections
List Group Connections
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/group_connections \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "offset": 1,
    "page_num": 2,
    "page_size": 2,
    "total_records": 1
  },
  "response": [
    {
      "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": 123,
      "group_data": {
        "carrier_group_id": "<string>",
        "group_name": "<string>",
        "broker_federal_ein": "<string>",
        "broker_tin": "<string>",
        "employer_email_address": "<string>"
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modified": 123,
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "request_type": "<string>",
      "setup_result": {},
      "status": "created",
      "version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "completed": 123,
      "federal_ein": "<string>",
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
Returns a list of all group connections.

Authorizations

Authorization
string
header
required

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

Query Parameters

page_size
integer

The max size of each page of results

offset
integer

The integer offset at which to start the page. Possible values are 0 to total_records - 1

id
string

Comma-separated list of requested Group Connection Request UUIDs

status
string

Status of the group connection for which you would like to filter. Multiple statuses can be used, separated by a comma.

carrier_id
string<uuid>

Comma-separated list of carrier UUID's for which you would like to view group connection requests

Example:

"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"

carrier_group_id
string

Used for filtering for a carrier-specific group ID. Must be used with a single carrier_id

organization_id
string<uuid>

The unique identifier of the organization for which you would like to view group connection requests

Example:

"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"

sort_by
string

The attribute on which to sort the group connections

sort_direction
string

Either asc or desc, to denote the data's direction

Response

200 - application/json

Successful Response - Returns all matching Group Connection Requests

meta
object
required

Metadata associated with the response data

response
object[]
required

List of group connection results