Skip to main content
GET
Get a list of all Groups

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

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