Members

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

List all organization members

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

orderstring · enumOptional

An order for the items in the list

Default: descPossible values:
roleone ofOptional

The Role to filter the member list by

string · enumOptional

"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.

Possible values:
searchstringOptional

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

sortstring · enumOptional

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

Default: joinedAtPossible values:
Responses
200

OK

application/json
Responseall of
get
/orgs/{organizationId}/members
GET /v1/orgs/{organizationId}/members HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "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-06T14:58:57.085Z",
      "lastSeenAt": "2025-11-06T14:58:57.085Z",
      "sso": true,
      "spaces": 1,
      "teams": 1
    }
  ]
}

Get an organization member by its ID

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

userIdstringRequired

The unique ID of the User

Responses
200

OK

application/json
get
/orgs/{organizationId}/members/{userId}
GET /v1/orgs/{organizationId}/members/{userId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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-06T14:58:57.085Z",
  "lastSeenAt": "2025-11-06T14:58:57.085Z",
  "sso": true,
  "spaces": 1,
  "teams": 1
}

Update an organization member

patch
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

userIdstringRequired

The unique ID of the User

Body
roleone ofOptional

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

string · enum | nullableOptional

"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.

Possible values:
Responses
200

The member has been updated

application/json
patch
/orgs/{organizationId}/members/{userId}
PATCH /v1/orgs/{organizationId}/members/{userId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "role": "admin"
}
200

The member has been updated

{
  "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-06T14:58:57.085Z",
  "lastSeenAt": "2025-11-06T14:58:57.085Z",
  "sso": true,
  "spaces": 1,
  "teams": 1
}

Delete an organization member

delete
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

userIdstringRequired

The unique ID of the User

Responses
204

Member did not exist in the organization.

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

No content

Set a user as an SSO member of an organization

post
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

userIdstringRequired

The unique ID of the User

Responses
200

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

application/json
post
/orgs/{organizationId}/members/{userId}/sso
POST /v1/orgs/{organizationId}/members/{userId}/sso HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

The user has been added as an SSO member of the 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-06T14:58:57.085Z",
  "lastSeenAt": "2025-11-06T14:58:57.085Z",
  "sso": true,
  "spaces": 1,
  "teams": 1
}
PreviousOrganizationsNextTeams

Last updated

Was this helpful?