Team members
Control membership at the team level for cohesive role management.
Easily add or remove users from teams, as well as fine-tune their specific roles within a team to ensure secure, well-organized collaboration.
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-07T00:25:34.759Z",
"lastSeenAt": "2025-11-07T00:25:34.759Z",
"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
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
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
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?