Members

A member in GitBook is the entity of a user associated with an organization.

List organization members

Lists members for the specified organization.

get

/orgs/{organizationId}/members

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber

The number of results per page

orderenum

An order for the items in the list

Options: asc, desc

roleone of

The Role to filter the member list by

searchstring

A query to filter the member list (displayName and email)

sortenum

The property to sort the results by. When sorting by lastSeenAt, only active members will be listed.

Options: joinedAt, lastSeenAt

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/members' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "role": "admin",
      "user": {
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "object": "user",
        "urls": {
          "location": "https://example.com"
        }
      },
      "spaces": 1,
      "teams": 1,
      "id": "text",
      "disabled": true,
      "joinedAt": "2025-02-15T13:20:33.696Z",
      "lastSeenAt": "2025-02-15T13:20:33.696Z",
      "sso": true,
      "object": "member"
    }
  ]
}

OK

Get specified organization member

Gets a specific member in an organization.

get

/orgs/{organizationId}/members/{userId}

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

userIdstringrequired

The unique ID of the User

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/members/{userId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

{
  "role": "admin",
  "user": {
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "object": "user",
    "urls": {
      "location": "https://example.com"
    }
  },
  "spaces": 1,
  "teams": 1,
  "id": "text",
  "disabled": true,
  "joinedAt": "2025-02-15T13:20:33.696Z",
  "lastSeenAt": "2025-02-15T13:20:33.696Z",
  "sso": true,
  "object": "member"
}

OK

Update specified organization member

Updates a specific member in an organization.

patch

/orgs/{organizationId}/members/{userId}

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

userIdstringrequired

The unique ID of the User

Body

roleone of

The role of a member in an organization, null for guests

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/members/{userId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"role":"admin"}'

200

default

200

{
  "role": "admin",
  "user": {
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "object": "user",
    "urls": {
      "location": "https://example.com"
    }
  },
  "spaces": 1,
  "teams": 1,
  "id": "text",
  "disabled": true,
  "joinedAt": "2025-02-15T13:20:33.696Z",
  "lastSeenAt": "2025-02-15T13:20:33.696Z",
  "sso": true,
  "object": "member"
}

The member has been updated

Delete a member from an organization

Deletes a specific member from an organization

delete

/orgs/{organizationId}/members/{userId}

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

userIdstringrequired

The unique ID of the User

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/members/{userId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

default

204

No body

The member was deleted from the organization.

Set a user as an SSO member of an organization

post

/orgs/{organizationId}/members/{userId}/sso

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

userIdstringrequired

The unique ID of the User

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/members/{userId}/sso' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

{
  "role": "admin",
  "user": {
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "object": "user",
    "urls": {
      "location": "https://example.com"
    }
  },
  "spaces": 1,
  "teams": 1,
  "id": "text",
  "disabled": true,
  "joinedAt": "2025-02-15T13:20:33.696Z",
  "lastSeenAt": "2025-02-15T13:20:33.696Z",
  "sso": true,
  "object": "member"
}

The user has been added as an SSO member of the organization.