Comment on page
Teams
A team in GitBook is the entity of a group that members of an organization belong to.
get
https://api.gitbook.com/v1
/orgs/{organizationId}/teams
List organization teams
Lists teams for the specified organization.
Parameters
Path
organizationId*
string
The unique id of the organization
Query
page
string
Identifier of the page results to fetch.
limit
number
The number of results per page
owner
string
The unique identifier of a member of the organization. Only teams they can manage will be returned.
title
string
If provided, only teams whose name contains the given parameter will be returned. Case insensitive.
Responses
200: OK
OK
default
Unexpected Error
put
https://api.gitbook.com/v1
/orgs/{organizationId}/teams
Create organization team
Creates a team in the specified organization.
Parameters
Path
organizationId*
string
The unique id of the organization
Body
Example
Schema
{
"title": "string",
"members": [
"string"
]
}
Responses
201: Created
Team has been created
default
Unexpected Error
get
https://api.gitbook.com/v1
/orgs/{organizationId}/teams/{teamId}
Get specified organization team
Gets a specific team in an organization.
Parameters
Path
organizationId*
string
The unique id of the organization
teamId*
string
The unique ID of the Team
Responses
200: OK
OK
default
Unexpected Error
patch
https://api.gitbook.com/v1
/orgs/{organizationId}/teams/{teamId}
Update specified organization team
Updates a specific team in an organization.
Parameters
Path
organizationId*
string
The unique id of the organization
teamId*
string
The unique ID of the Team
Body
Example
Schema
{
"title": "string"
}
Responses
200: OK
The team has been updated
default
Unexpected Error
delete
https://api.gitbook.com/v1
/orgs/{organizationId}/teams/{teamId}
Delete a team in an organization
Deletes a specific team in an organization
Parameters
Path
organizationId*
string
The unique id of the organization
teamId*
string
The unique ID of the Team
Responses
204: No Content
The team was deleted from the organization.
default
Unexpected Error
get
https://api.gitbook.com/v1
/orgs/{organizationId}/teams/{teamId}/members
List team members
Lists members, and their roles, for the specified organization team.
Parameters
Path
organizationId*
string
The unique id of the organization
teamId*
string
The unique ID of the Team
Query
page
string
Identifier of the page results to fetch.
limit
number
The number of results per page
Responses
200: OK
OK
default
Unexpected Error
put
https://api.gitbook.com/v1
/orgs/{organizationId}/teams/{teamId}/members
Updates members of an organization team
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.
Parameters
Path
organizationId*
string
The unique id of the organization
teamId*
string
The unique ID of the Team
Body
Example
Schema
{
"add": [
"string"
],
"memberships": {
"additionalProp1": {
"role": "owner"
},
"additionalProp2": {
"role": "owner"
},
"additionalProp3": {
"role": "owner"
}
},
"remove": [
"string"
]
}
Responses
204: No Content
Members have been updated
default
Unexpected Error
put
https://api.gitbook.com/v1
/orgs/{organizationId}/teams/{teamId}/members/{userId}
Add or update a team membership
Add or updates member in the specified organization team.
Parameters
Path
organizationId*
string
The unique id of the organization
teamId*
string
The unique ID of the Team
userId*
string
The unique ID of the User
Body
Example
Schema
{
"role": "owner"
}
Responses
204: No Content
Member has been added to the team
default
Unexpected Error
delete
https://api.gitbook.com/v1
/orgs/{organizationId}/teams/{teamId}/members/{userId}
Delete members from a team
Deletes member from the specified organization team.
Parameters
Path
organizationId*
string
The unique id of the organization
teamId*
string
The unique ID of the Team
userId*
string
The unique ID of the User
Responses
204: No Content
Member has been deleted from the team
default
Unexpected Error
Last modified 7mo ago