Teams

Create and manage teams as reusable groups of users.

Teams offer a convenient way to assign roles and access to multiple users at once. This helps maintain large-scale projects more efficiently by reducing overhead in user-by-user management.

The Team object

Attributes

objectstring · enumrequired

Type of Object, always equals to "team"

Available options:

idstringrequired

Unique identifier for the team

The Team object

{
  "object": "team",
  "id": "text"
}

List all teams

get

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

pagestringoptional

Identifier of the page results to fetch.

limitnumber · max: 1000optional

The number of results per page

ownerstringoptional

The unique identifier of a member of the organization. Only teams they can manage will be returned.

titlestringoptional

If provided, only teams whose name contains the given parameter will be returned. Case insensitive.

Responses

application/json

all ofoptional

get

GET /v1/orgs/{organizationId}/teams HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "team",
      "id": "text",
      "title": "text",
      "members": 1,
      "spaces": 1,
      "createdAt": "2025-04-22T18:04:01.998Z"
    }
  ]
}

Create a team

put

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Body

titlestring · min: 1 · max: 64required

Title of the team

membersstring[]optional

A list of organization member identifiers

Responses

application/json

objectoptional

put

PUT /v1/orgs/{organizationId}/teams HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "title": "text",
  "members": [
    "text"
  ]
}

201

Team has been created

{
  "object": "team",
  "id": "text",
  "title": "text",
  "members": 1,
  "spaces": 1,
  "createdAt": "2025-04-22T18:04:01.998Z"
}

Get a team

get

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

teamIdstringrequired

The unique ID of the Team

Responses

application/json

objectoptional

get

GET /v1/orgs/{organizationId}/teams/{teamId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "object": "team",
  "id": "text",
  "title": "text",
  "members": 1,
  "spaces": 1,
  "createdAt": "2025-04-22T18:04:01.998Z"
}

Delete a team

delete

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

teamIdstringrequired

The unique ID of the Team

Responses

delete

DELETE /v1/orgs/{organizationId}/teams/{teamId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

The team was deleted from the organization.

No Content

Update a team

patch

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

teamIdstringrequired

The unique ID of the Team

Body

titlestring · min: 1 · max: 64required

Title of the team

Responses

application/json

objectoptional

patch

PATCH /v1/orgs/{organizationId}/teams/{teamId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}

200

The team has been updated

{
  "object": "team",
  "id": "text",
  "title": "text",
  "members": 1,
  "spaces": 1,
  "createdAt": "2025-04-22T18:04:01.998Z"
}

Was this helpful?