Teams
A team in GitBook is the entity of a group that members of an organization belong to.
The unique id of the organization
Identifier of the page results to fetch.
The number of results per page
The unique identifier of a member of the organization. Only teams they can manage will be returned.
If provided, only teams whose name contains the given parameter will be returned. Case insensitive.
OK
GET /v1/orgs/{organizationId}/teams HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"next": {
"page": "text"
},
"count": 1,
"items": [
{
"object": "team",
"id": "text",
"title": "text",
"members": 1,
"spaces": 1,
"createdAt": "2025-11-06T14:53:46.887Z",
"permissions": {
"admin": true,
"view": true
}
}
]
}The unique id of the organization
Title of the team
A list of organization member identifiers
Team has been created
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"
]
}Team has been created
{
"object": "team",
"id": "text",
"title": "text",
"members": 1,
"spaces": 1,
"createdAt": "2025-11-06T14:53:46.887Z",
"permissions": {
"admin": true,
"view": true
}
}The unique id of the organization
The unique ID of the Team
OK
GET /v1/orgs/{organizationId}/teams/{teamId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"object": "team",
"id": "text",
"title": "text",
"members": 1,
"spaces": 1,
"createdAt": "2025-11-06T14:53:46.887Z",
"permissions": {
"admin": true,
"view": true
}
}The unique id of the organization
The unique ID of the Team
Title of the team
The team has been updated
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"
}The team has been updated
{
"object": "team",
"id": "text",
"title": "text",
"members": 1,
"spaces": 1,
"createdAt": "2025-11-06T14:53:46.887Z",
"permissions": {
"admin": true,
"view": true
}
}The unique id of the organization
The unique ID of the Team
The team did not exist in the organization.
No content
The team was deleted from the organization.
DELETE /v1/orgs/{organizationId}/teams/{teamId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Lists members, and their roles, for the specified organization team.
The unique id of the organization
The unique ID of the Team
Identifier of the page results to fetch.
The number of results per page
OK
GET /v1/orgs/{organizationId}/teams/{teamId}/members HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"next": {
"page": "text"
},
"count": 1,
"items": [
{
"organization": {
"object": "member",
"id": "text",
"role": "admin",
"user": {
"object": "user",
"id": "text",
"displayName": "text",
"email": "text",
"photoURL": "text",
"urls": {
"location": "https://example.com"
}
},
"disabled": true,
"joinedAt": "2025-11-06T14:53:46.887Z",
"lastSeenAt": "2025-11-06T14:53:46.887Z",
"sso": true,
"spaces": 1,
"teams": 1
},
"team": {
"role": "owner"
},
"permissions": {
"view": true
}
}
]
}Updates members of an organization team, either adding or removing them. If a the same user is included as both an add and a remove, they will be removed from the team.
The unique id of the organization
The unique ID of the Team
A user to add. It can either be a user ID or an email.
A user to remove. It can either be a user ID or an email.
Members have been updated
No content
PUT /v1/orgs/{organizationId}/teams/{teamId}/members HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93
{
"add": [
"text"
],
"memberships": {
"ANY_ADDITIONAL_PROPERTY": {
"role": "owner"
}
},
"remove": [
"text"
]
}Members have been updated
No content
Add or updates member in the specified organization team.
The unique id of the organization
The unique ID of the Team
The unique ID of the User
"The role of a team member. "owner": Can manage team members. "member": Is a member of the team.
Member has been added to the team
No content
PUT /v1/orgs/{organizationId}/teams/{teamId}/members/{userId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"role": "owner"
}Member has been added to the team
No content
Deletes member from the specified organization team.
The unique id of the organization
The unique ID of the Team
The unique ID of the User
Member was not part of the team
No content
Member has been deleted from the team
DELETE /v1/orgs/{organizationId}/teams/{teamId}/members/{userId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated
Was this helpful?