List teams

Operation ID: teams

Group: People Management › Teams

Open in the interactive reference

GET /people/teams

Read-only: Reads and returns; changes nothing.

Lists teams. To list one team's direct child teams, filter by parentId.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.

Query surface

Response

200 Success

Under data, an array of teamsRow:

Field Type Required Filter Sort Description
id string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The unique identifier for the team.
teamNumber string | null no no yes The system-generated team number. Absent while none has been assigned.
name string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The name of the team.
teamType string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The type of the team. Possible values: 'hrTeam', 'psaTeam'.
status string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The status of the team, derived from its dates. 'planned' before the start date, 'active' between the dates, 'inactive' after the end date.
startDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The first day the team exists. Format YYYY-MM-DD.
endDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The last day the team exists. Format YYYY-MM-DD. Absent for a team with no planned end.
employeeCount number | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The number of active members of the team.
parentId string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) no The identifier of the parent team. Absent for a top-level team. See id on GET people/teams/:id.
parentName string | null no no no The name of the parent team. Absent for a top-level team.
lastModifiedDate date-time no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date and time the team record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. 
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "teamNumber": "<teamNumber>",
      "name": "<name>",
      "teamType": "<teamType>",
      "status": "<status>",
      "startDate": "2026-01-15",
      "endDate": "2026-01-15",
      "employeeCount": 0,
      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parentName": "<parentName>",
      "lastModifiedDate": "2026-01-15T09:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses