GET
/
api
/
v1
/
groups
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/groups
{
  "meta": {
    "offset": 0,
    "page_num": 1,
    "page_size": 20,
    "total_records": 1
  },
  "response": [
    {
      "created": 1557512389,
      "dba_name": "Test Corp",
      "federal_ein": "112222222",
      "id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
      "modified": 1543215342,
      "name": "Test Company",
      "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e",
      "sic_code": "7371",
      "version": "6b72d72d-cc99-4df6-8152-7183e824c80c"
    }
  ]
}

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

​
company
string

This query param searches groups by name or dba_name values

​
group_ids
string

Comma-separated list of requested UUID group IDs

​
carrier_id
string

Used for filtering for a carrier-specific group ID. Filter by the Noyo carrier ID. Must be used with carrier_group_id

​
carrier_group_id
string

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

Response

200 - application/json
Successful Response - Returns all matching Groups
​
meta
object
required

Metadata associated with the response data

​
response
object[]
required

List of group results

Was this page helpful?

Get GroupList Carrier Configurations for Group