Teams
Make a GET request to /teams to retrieve a list of the teams in your account.
GET /teams
{
"mode": "live",
"object": "list",
"total_count": 3,
"has_more": false,
"data": [
{
"object": "team_list_item",
"id": 178,
"display_name": "Career Coaching",
"users_count": 9,
"invitations_count": 15,
"test_takers_count": 11
},
{
"object": "team_list_item",
"id": 470,
"display_name": "Executive Training",
"users_count": 4,
"invitations_count": 2,
"test_takers_count": 2
},
{
"object": "team_list_item",
"id": 328,
"display_name": "Recruiting",
"users_count": 5,
"invitations_count": 144,
"test_takers_count": 92
}
]
}
Response fields
List envelope
| Field | Description |
|---|---|
mode | "live" or "test" depending on your API key |
object | Always "list" |
total_count | Total number of teams in your account |
has_more | true if more items exist beyond the current page |
data | Array of team_list_item objects |
team_list_item fields
| Field | Description |
|---|---|
object | Always "team_list_item" |
id | Team ID |
display_name | Team name |
users_count | Number of users on the team |
invitations_count | Number of invitations on the team |
test_takers_count | Number of test takers on the team |
Use GET /email-templates to see which templates are available for your account and which teams they are assigned to.