Get a team

GET 
/v1/teams/:name

This route allows you to fetch a specific team in your Port organization.

To learn more about teams, check out the documentation.

Request

Path Parameters

name stringrequired

The name of the team you want to fetch.

Query Parameters

fields undefined[]

Possible values: [id, name, createdAt, updatedAt, provider, description, users.firstName, users.lastName, users.email, users.picture, users.status]

The fields you want to fetch for the team. If used, only the specified fields will be included in the response.

Responses

200

Retrieved successfully.

application/json

Schema

Schema

okanyrequired

Possible values: [true]

team

object

required

idstring

namestring

createdAtdate-time

updatedAtdate-time

providerstring

descriptionstring

Example (from schema)

{
  "ok": true,
  "team": {
    "id": "string",
    "name": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "provider": "string",
    "description": "string"
  }
}