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.

Was this helpful?

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

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

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

{
  "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-26T20:44:16.148Z",
        "lastSeenAt": "2025-08-26T20:44:16.148Z",
        "sso": true,
        "spaces": 1,
        "teams": 1
      },
      "team": {
        "role": "owner"
      },
      "permissions": {
        "view": true
      }
    }
  ]
}

Team members

The TeamMember object

The TeamMember object

List all team members

Updates members of a team

Add a team member

Delete a team member