Skip to content

Get and Update Team

Both operations use POST /public-api/publicapi.v1.Team/. The exact read/update scopes (team:read / team:update) and creator’s current team permissions apply.

{ "id": "<team-id>" }

Returns team, not a global directory entry or effective Customer View.

Generated Reference
POST /public-api/publicapi.v1.Team/GetTeam
Request GetTeamRequest
Response GetTeamResponse

GetTeamRequest

Field Type
id string

GetTeamResponse

Field Type
team Team
{ "id": "<team-id>", "name": "Installation", "color": "#008080" }

Supply at least one of name, description, or color; omitted fields are preserved. Name is nonblank, maximum 50 characters; description is 1 through 1,000 characters; color is a six-digit #RRGGBB value. Empty values cannot clear the description. Returns team. Membership and role assignments are unchanged. Do not blindly retry mutations after a timeout; inspect current state first.

Generated Reference
POST /public-api/publicapi.v1.Team/UpdateTeam

Updates non-empty supplied fields; omitted fields are preserved. Does not replace membership. Description cannot be cleared by this operation.

Request UpdateTeamRequest
Response UpdateTeamResponse

UpdateTeamRequest

Field Type
id string
name optional string
description optional string
color optional string

UpdateTeamResponse

Field Type
team Team