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"

Possible values:

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

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "team",
      "id": "text",
      "title": "text",
      "members": 1,
      "spaces": 1,
      "createdAt": "2025-05-05T06:12:42.601Z",
      "permissions": {
        "admin": true,
        "view": true
      }
    }
  ]
}

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

201

Team has been created

application/json

put

HTTPcURLJavaScriptPython

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-05-05T06:12:42.601Z",
  "permissions": {
    "admin": true,
    "view": true
  }
}

Get a team

get

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

teamIdstringRequired

The unique ID of the Team

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

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

200

OK

{
  "object": "team",
  "id": "text",
  "title": "text",
  "members": 1,
  "spaces": 1,
  "createdAt": "2025-05-05T06:12:42.601Z",
  "permissions": {
    "admin": true,
    "view": true
  }
}

Delete a team

delete

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

teamIdstringRequired

The unique ID of the Team

Responses

204

The team was deleted from the organization.

delete

HTTPcURLJavaScriptPython

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

200

The team has been updated

application/json

patch

HTTPcURLJavaScriptPython

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-05-05T06:12:42.601Z",
  "permissions": {
    "admin": true,
    "view": true
  }
}