GET
/
api
/
v3
/
groups

Parameters

page
integer

The page number of the results you want to retrieve (the first page is 1). See Pagination for more information.

per_page
integer

The number of users to be returned per page (max is 100). See Pagination for more information.

Response

current_page
integer
required

The current page being returned (used for pagination purposes).

per_page
integer
required

The number of results being returned per page (used for pagination purposes).

total_groups
integer
required

The total number of team groups (used for pagination purposes).

groups
array
required

List of team group objects

id
string
required

The team groups’s identifier

budget
integer
required

The team groups’s budget

created_at
string
required

The team group’s creation date (in ISO 8601 format)

monthly_budget
string
required

The team group’s monthly allocated budget

name
number
required

The team group’s name

one_time_budget
integer
required

The team group’s one time budget

rollover
boolean
required

Whether or not the monthly budget rolls over to the next month or not.

team_id
integer
required

The team group’s organization id

updated_at
string
required

The team group’s last updated date (in ISO 8601 format)