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.

The TeamMember object

Attributes

rolestring · enumRequired

"The role of a team member. "owner": Can manage team members. "member": Is a member of the team.

Possible values:

The TeamMember object

{
  "role": "owner"
}

List all team members

get

Lists members, and their roles, for the specified organization team.

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

teamIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

get

/orgs/{organizationId}/teams/{teamId}/members

HTTPcURLJavaScriptPython

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

200

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": "2026-03-18T11:48:24.263Z",
        "lastSeenAt": "2026-03-18T11:48:24.263Z",
        "sso": true,
        "spaces": 1,
        "teams": 1
      },
      "team": {
        "role": "owner"
      },
      "permissions": {
        "view": true
      }
    }
  ]
}

Updates members of a team

put

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.

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

teamIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

addstring[]Optional

A user to add. It can either be a user ID or an email.

removestring[]Optional

A user to remove. It can either be a user ID or an email.

Responses

204

Members have been updated

put

/orgs/{organizationId}/teams/{teamId}/members

HTTPcURLJavaScriptPython

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"
  ]
}

204

Members have been updated

No content

Add a team member

put

Add or updates member in the specified organization team.

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

teamIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

userIdstringRequired

The unique ID of the User

Body

application/json

rolestring · enumOptional

"The role of a team member. "owner": Can manage team members. "member": Is a member of the team.

Possible values:

Responses

204

Member has been added to the team

put

/orgs/{organizationId}/teams/{teamId}/members/{userId}

HTTPcURLJavaScriptPython

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"
}

204

Member has been added to the team

No content

Delete a team member

delete

Deletes member from the specified organization team.

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

teamIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

userIdstringRequired

The unique ID of the User

Responses

204

Member was not part of the team

205

Member has been deleted from the team

delete

/orgs/{organizationId}/teams/{teamId}/members/{userId}

HTTPcURLJavaScriptPython

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

No content