Get Team

GET /people/teams/{id}

Group: People Management › Teams · Operation ID: getTeam

Returns the team with the given identifier. Use the team's id, not its teamNumber.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "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.
id path string yes The unique identifier for the team to return.

Response

200 Success

Under data (getTeamOutput):

Field Type Required Description
id string yes The unique identifier for the team.
teamNumber string no The system-generated team number. Absent while none has been assigned.
name string yes The name of the team.
teamType string, one of "hrTeam", "psaTeam" no The type of the team.
status string, one of "planned", "active", "inactive" no The status of the team, derived from its dates. 'planned' before the start date, 'active' between the dates, 'inactive' after the end date.
startDate string no The first day the team exists. Format YYYY-MM-DD.
endDate string no The last day the team exists. Format YYYY-MM-DD. Absent for a team with no planned end.
employeeCount number no The number of active members of the team.
parentId string no The identifier of the parent team. Absent for a top-level team. See id on GET people/teams/:id.
parentName string no The name of the parent team. Absent for a top-level team.
lastModifiedDate string (date-time) yes The date and time the team record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses