teams

List teams

Changed on

List teams. For non-administrator users, will only list the teams they are member of. Access policy: restricted

get/teams

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/teams
  • Auth
    • API key in header X-API-KEY
    • or API key in header Authorization

Query parameters

onlyLedTeamsboolean

Only list teams that the user is leader of

environmentIdinteger

Identifier of the environment(endpoint) that will be used to filter the authorized teams

Response

Success

DenyPortainerAccessboolean

Whether members of this team are denied access to Portainer itself (EE only)

Idinteger

Team Identifier

Namestring

Team name

Example response

[
  {
    "Id": 1,
    "Name": "developers"
  }
]

Changes