Explore how adaptive content transforms your docs into a dynamic, tailored experience for every user.
Read the docs
LogoLogo
ProductPricingLog inSign up
  • Documentation
  • Developers
  • Guides
  • Changelog
  • Help Center
  • Getting Started
    • Developer Documentation
    • Quickstart
    • Development
    • Publishing
  • Integrations
    • Introduction
    • Using the CLI
    • Configuration
    • ContentKit
      • Component reference
    • Integration runtime
  • Client library
  • Guides
    • Creating a custom unfurl action
    • Creating interactive blocks
    • Referencing your integration in Markdown
    • Working with HTTP requests
    • Using the CLI in CI/CD
  • GitBook API
    • Introduction
    • Authentication
    • API reference
      • Organizations
        • Organization members
        • Organization invites
        • Organization AI ask
      • Docs sites
        • Site share links
        • Site structure
        • Site auth
        • Site preview
        • Site customization
        • Site spaces
        • Site sections
        • Site section groups
        • Site redirects
        • Site MCP servers
        • Site ads
        • Site users
        • Site insights
        • Site AI ask
      • Collections
        • Collection users
        • Collection teams
      • Spaces
        • Space content
        • Space comments
        • Space embeds
        • Space users
        • Space teams
        • Space integrations
        • Git
      • Change requests
        • Change request content
        • Change request contributors
        • Change request reviewers
        • Change request comments
      • Translations
        • Glossary
      • Integrations
      • URLs
      • OpenAPI
        • OpenAPI spec versions
      • Conversations
      • Custom fonts
      • Subdomains
      • Users
      • Teams
        • Team members
      • SSO
      • Storage
      • Custom hostnames
      • System info
    • Rate limiting
    • Pagination
    • Errors
  • Marketplace
    • Overview
    • Submit your app for review
  • Resources
    • Concepts
    • Changelog
    • ContentKit playground
    • GitHub examples
Powered by GitBook
On this page
  1. GitBook API
  2. API reference
  3. Teams

Team members

Control membership at the team level for cohesive role management.

Was this helpful?

LogoLogo

Resources

  • Showcase
  • Enterprise
  • Status

Company

  • Careers
  • Blog
  • Community

Policies

  • Subprocessors
  • Terms of Service
CtrlK
  • The TeamMember object
  • GETList all team members
  • PUTUpdates members of a team
  • PUTAdd a team member
  • DELETEDelete a team member

Was this helpful?

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
Path parameters
organizationIdstringRequired

The unique id of the organization

teamIdstringRequired

The unique ID of the Team

Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses
200

OK

application/json
Responseall of
get
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": "2025-08-26T23:19:07.272Z",
        "lastSeenAt": "2025-08-26T23:19:07.272Z",
        "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
Path parameters
organizationIdstringRequired

The unique id of the organization

teamIdstringRequired

The unique ID of the Team

Body
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
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
Path parameters
organizationIdstringRequired

The unique id of the organization

teamIdstringRequired

The unique ID of the Team

userIdstringRequired

The unique ID of the User

Body
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
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
Path parameters
organizationIdstringRequired

The unique id of the organization

teamIdstringRequired

The unique ID of the Team

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
DELETE /v1/orgs/{organizationId}/teams/{teamId}/members/{userId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content