Organizations

Get the list of organizations for the currently authenticated user

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs

GET /v1/orgs HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "organization",
      "id": "text",
      "title": "text",
      "createdAt": "2026-01-25T23:20:04.240Z",
      "emailDomains": [
        "text"
      ],
      "hostname": "text",
      "type": "business",
      "useCase": "internalDocs",
      "communityType": "nonProfit",
      "defaultRole": "admin",
      "defaultContent": {
        "type": "site",
        "site": "text"
      },
      "sso": true,
      "ai": true,
      "inviteLinks": true,
      "plan": "free_2024",
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com",
        "logo": "https://example.com"
      },
      "trialDecision": "downgrade",
      "customHostname": "text",
      "blocked": {
        "reason": "security"
      },
      "internal_isUsingSnippets": true,
      "internal_isOnNewTrial": true,
      "permissions": {
        "admin": true,
        "createContent": true
      }
    }
  ]
}

Create an organization

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

titlestring · min: 2 · max: 255Required

Name of the organization

emailDomainsstring[]Optional

typestring · enumOptionalPossible values:

useCasestring · enumOptionalPossible values:

Responses

201

Organization created

application/json

default

Unexpected Error

application/json

post

/orgs

POST /v1/orgs HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "title": "text",
  "emailDomains": [
    "text"
  ],
  "type": "business",
  "useCase": "internalDocs"
}

{
  "object": "organization",
  "id": "text",
  "title": "text",
  "createdAt": "2026-01-25T23:20:04.240Z",
  "emailDomains": [
    "text"
  ],
  "hostname": "text",
  "type": "business",
  "useCase": "internalDocs",
  "communityType": "nonProfit",
  "defaultRole": "admin",
  "defaultContent": {
    "type": "site",
    "site": "text"
  },
  "sso": true,
  "ai": true,
  "inviteLinks": true,
  "plan": "free_2024",
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "logo": "https://example.com"
  },
  "trialDecision": "downgrade",
  "customHostname": "text",
  "blocked": {
    "reason": "security"
  },
  "internal_isUsingSnippets": true,
  "internal_isOnNewTrial": true,
  "permissions": {
    "admin": true,
    "createContent": true
  }
}

Get an organization by its ID

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

404

No matching organization found for given id

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}

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

{
  "object": "organization",
  "id": "text",
  "title": "text",
  "createdAt": "2026-01-25T23:20:04.240Z",
  "emailDomains": [
    "text"
  ],
  "hostname": "text",
  "type": "business",
  "useCase": "internalDocs",
  "communityType": "nonProfit",
  "defaultRole": "admin",
  "defaultContent": {
    "type": "site",
    "site": "text"
  },
  "sso": true,
  "ai": true,
  "inviteLinks": true,
  "plan": "free_2024",
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "logo": "https://example.com"
  },
  "trialDecision": "downgrade",
  "customHostname": "text",
  "blocked": {
    "reason": "security"
  },
  "internal_isUsingSnippets": true,
  "internal_isOnNewTrial": true,
  "permissions": {
    "admin": true,
    "createContent": true
  }
}

Delete an organization by its ID

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

205

The organization has been successfully deleted

404

No matching organization found for given id

application/json

default

Unexpected Error

application/json

delete

/orgs/{organizationId}

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

No content

Update an organization by its ID

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

titlestring · min: 2 · max: 255Optional

Name of the organization

emailDomainsstring[]Optional

hostnamestring · min: 3 · max: 32Optional

Default hostname for the organization's public content, e.g. .gitbook.io

defaultRoleone 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:

defaultContentone ofOptional

string · enum | nullableOptionalPossible values:

logoone ofOptional

string · uriOptional

string · enum | nullableOptionalPossible values:

ssobooleanOptional

aibooleanOptional

inviteLinksbooleanOptional

Responses

200

The organization has been updated

application/json

400

Invalid default content space or collection provided

application/json

default

Unexpected Error

application/json

patch

/orgs/{organizationId}

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

{
  "title": "text",
  "emailDomains": [
    "text"
  ],
  "hostname": "text",
  "defaultRole": "admin",
  "defaultContent": {
    "type": "site",
    "site": "text"
  },
  "logo": "https://example.com",
  "sso": true,
  "ai": true,
  "inviteLinks": true
}

{
  "object": "organization",
  "id": "text",
  "title": "text",
  "createdAt": "2026-01-25T23:20:04.240Z",
  "emailDomains": [
    "text"
  ],
  "hostname": "text",
  "type": "business",
  "useCase": "internalDocs",
  "communityType": "nonProfit",
  "defaultRole": "admin",
  "defaultContent": {
    "type": "site",
    "site": "text"
  },
  "sso": true,
  "ai": true,
  "inviteLinks": true,
  "plan": "free_2024",
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "logo": "https://example.com"
  },
  "trialDecision": "downgrade",
  "customHostname": "text",
  "blocked": {
    "reason": "security"
  },
  "internal_isUsingSnippets": true,
  "internal_isOnNewTrial": true,
  "permissions": {
    "admin": true,
    "createContent": true
  }
}

List all content in an organization

get

Lists all spaces, collections, sites accessible by current user in the current organization. This endpoint is internal for now as the data structure is optimized for the sidebar.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/content

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

{
  "sites": [
    {
      "site": {
        "object": "site",
        "id": "text",
        "type": "basic",
        "title": "text",
        "hostname": "text",
        "basename": "text",
        "proxy": "text",
        "visibility": "public",
        "published": true,
        "siteSpaces": 1,
        "createdAt": "2026-01-25T23:20:04.240Z",
        "adaptiveContent": {
          "enabled": true
        },
        "ads": {
          "status": "pending",
          "submittable": true
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "published": "https://example.com"
        }
      },
      "structure": {
        "type": "sections",
        "structure": [
          {
            "object": "site-section",
            "id": "text",
            "title": "text",
            "default": true,
            "path": "text",
            "condition": "text",
            "sectionGroup": "text",
            "siteSpaces": [
              {
                "object": "site-space",
                "id": "text",
                "path": "text",
                "section": "text",
                "space": {
                  "object": "space",
                  "id": "text",
                  "title": "text",
                  "emoji": "🎉",
                  "visibility": "public",
                  "createdAt": "2026-01-25T23:20:04.240Z",
                  "updatedAt": "2026-01-25T23:20:04.240Z",
                  "deletedAt": "2026-01-25T23:20:04.240Z",
                  "editMode": "live",
                  "urls": {
                    "location": "https://example.com",
                    "app": "https://example.com",
                    "published": "https://example.com",
                    "public": "https://example.com",
                    "icon": "https://example.com"
                  },
                  "organization": "text",
                  "parent": "text",
                  "gitSync": {
                    "installationProvider": "github",
                    "integration": "text",
                    "url": "text",
                    "updatedAt": "2026-01-25T23:20:04.240Z"
                  },
                  "visitorAuth": {
                    "backend": "custom"
                  },
                  "revision": "text",
                  "defaultLevel": "admin",
                  "comments": 1,
                  "changeRequests": 1,
                  "changeRequestsOpen": 1,
                  "changeRequestsDraft": 1,
                  "permissions": {
                    "access": true,
                    "admin": true,
                    "edit": true,
                    "comment": true,
                    "merge": true,
                    "review": true
                  }
                },
                "title": "text",
                "default": true,
                "condition": "text",
                "hasAdvancedCustomizationFeature": true,
                "urls": {
                  "published": "https://example.com"
                }
              }
            ],
            "urls": {
              "published": "https://example.com"
            },
            "icon": "gear"
          }
        ]
      }
    }
  ],
  "spaces": [
    {
      "collection": {
        "object": "collection",
        "id": "text",
        "title": "text",
        "description": "text",
        "organization": "text",
        "parent": "text",
        "defaultLevel": "admin",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com"
        },
        "permissions": {
          "admin": true,
          "create": true
        }
      },
      "content": [
        {
          "collection": {
            "object": "collection",
            "id": "text",
            "title": "text",
            "description": "text",
            "organization": "text",
            "parent": "text",
            "defaultLevel": "admin",
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com"
            },
            "permissions": {
              "admin": true,
              "create": true
            }
          },
          "content": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ],
  "deletedSpaces": [
    {
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2026-01-25T23:20:04.240Z",
        "updatedAt": "2026-01-25T23:20:04.240Z",
        "deletedAt": "2026-01-25T23:20:04.240Z",
        "editMode": "live",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "published": "https://example.com",
          "public": "https://example.com",
          "icon": "https://example.com"
        },
        "organization": "text",
        "parent": "text",
        "gitSync": {
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2026-01-25T23:20:04.240Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "permissions": {
          "access": true,
          "admin": true,
          "edit": true,
          "comment": true,
          "merge": true,
          "review": true
        }
      }
    }
  ]
}

List organization members

get

Lists members for the specified organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

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

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/members

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

{
  "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": "2026-01-25T23:20:04.240Z",
      "lastSeenAt": "2026-01-25T23:20:04.240Z",
      "sso": true,
      "spaces": 1,
      "teams": 1
    }
  ]
}

Get specified organization member

get

Gets a specific member in an organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

userIdstringRequired

The unique ID of the User

Responses

200

application/json

default

Unexpected Error

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: */*

{
  "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-01-25T23:20:04.240Z",
  "lastSeenAt": "2026-01-25T23:20:04.240Z",
  "sso": true,
  "spaces": 1,
  "teams": 1
}

Delete a member from an organization

delete

Deletes a specific member from an organization

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

userIdstringRequired

The unique ID of the User

Responses

204

The member was deleted from the organization.

default

Unexpected Error

application/json

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

Update specified organization member

patch

Updates a specific member in an organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

Possible values:

Responses

200

The member has been updated

application/json

default

Unexpected Error

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

{
  "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-01-25T23:20:04.240Z",
  "lastSeenAt": "2026-01-25T23:20:04.240Z",
  "sso": true,
  "spaces": 1,
  "teams": 1
}

Update organization member's "last seen at" timestamp.

post

Update organization member's "last seen at" timestamp.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

Organization member has been updated. Optionally returns a JWT token to attach to the user.

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/ping

POST /v1/orgs/{organizationId}/ping HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "gitbookVisitorClaims": "text"
}

Set a user as an SSO member of an organization

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

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: */*

{
  "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-01-25T23:20:04.240Z",
  "lastSeenAt": "2026-01-25T23:20:04.240Z",
  "sso": true,
  "spaces": 1,
  "teams": 1
}

List organization teams

get

Lists teams for the specified organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

ownerstringOptional

The unique identifier of a member of the organization. Only teams they can manage will be returned.

titlestringOptional

If provided, only teams whose name contains the given parameter will be returned. Case insensitive.

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/teams

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "team",
      "id": "text",
      "title": "text",
      "members": 1,
      "spaces": 1,
      "createdAt": "2026-01-25T23:20:04.240Z"
    }
  ]
}

Create organization team

put

Creates a team in the specified organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

titlestring · min: 1 · max: 64Required

Title of the team

membersstring[]Optional

A list of organization member identifiers

Responses

201

Team has been created

application/json

default

Unexpected Error

application/json

put

/orgs/{organizationId}/teams

PUT /v1/orgs/{organizationId}/teams HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "title": "text",
  "members": [
    "text"
  ]
}

{
  "object": "team",
  "id": "text",
  "title": "text",
  "members": 1,
  "spaces": 1,
  "createdAt": "2026-01-25T23:20:04.240Z"
}

Get specified organization team

get

Gets a specific team in an organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

teamIdstringRequired

The unique ID of the Team

Responses

200

application/json

default

Unexpected Error

application/json

get

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

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

{
  "object": "team",
  "id": "text",
  "title": "text",
  "members": 1,
  "spaces": 1,
  "createdAt": "2026-01-25T23:20:04.240Z"
}

Delete a team in an organization

delete

Deletes a specific team in an organization

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

teamIdstringRequired

The unique ID of the Team

Responses

204

The team was deleted from the organization.

default

Unexpected Error

application/json

delete

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

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

No content

Update specified organization team

patch

Updates a specific team in an organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

teamIdstringRequired

The unique ID of the Team

Body

titlestring · min: 1 · max: 64Required

Title of the team

Responses

200

The team has been updated

application/json

default

Unexpected Error

application/json

patch

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

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

{
  "title": "text"
}

{
  "object": "team",
  "id": "text",
  "title": "text",
  "members": 1,
  "spaces": 1,
  "createdAt": "2026-01-25T23:20:04.240Z"
}

List team members

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

application/json

default

Unexpected Error

application/json

get

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

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

{
  "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-01-25T23:20:04.240Z",
        "lastSeenAt": "2026-01-25T23:20:04.240Z",
        "sso": true,
        "spaces": 1,
        "teams": 1
      },
      "team": {
        "role": "owner"
      }
    }
  ]
}

Updates members of an organization 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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

application/json

put

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

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

No content

Add or update a team membership

put

Add or updates member in the specified organization team.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

application/json

put

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

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

No content

Delete members from a team

delete

Deletes member from the specified organization team.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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 has been deleted from the team

default

Unexpected Error

application/json

delete

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

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

No content

Invite users to a given organization based on a list of emails

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

roleone ofOptional

Default role to set on newly invited members.

string · enum | nullableOptional

Possible values:

ssobooleanOptional

If true, invites the user as an SSO user of the organization. Defaults to false.

Responses

200

application/json

400

Bad Request

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/invites

POST /v1/orgs/{organizationId}/invites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "emails": [
    "text"
  ],
  "role": "admin",
  "sso": true
}

{
  "users": [
    "text"
  ],
  "invited": 1,
  "failedSSOEmails": [
    "text"
  ]
}

Use an invite to join an organization.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

inviteIdstringRequired

The unique id of the invite

Responses

200

application/json

Responseobject

default

Unexpected Error

application/json

post

/orgs/{organizationId}/invites/{inviteId}

POST /v1/orgs/{organizationId}/invites/{inviteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

List invite links to content in an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

spacestringOptional

If specified, only return invite links that provide specific permissions on the given space.

collectionstringOptional

If specified, only return invite links that provide permissions on the given collection.

Responses

200

List of invite links to content in the organization.

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/content-link-invites

GET /v1/orgs/{organizationId}/content-link-invites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "invite",
      "id": "text",
      "level": "admin",
      "collection": {
        "object": "collection",
        "id": "text",
        "title": "text",
        "description": "text",
        "organization": "text",
        "parent": "text",
        "defaultLevel": "admin",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com"
        },
        "permissions": {
          "admin": true,
          "create": true
        }
      }
    }
  ]
}

List invite links to an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

Responses

200

List of invite links in the organization.

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/link-invites

GET /v1/orgs/{organizationId}/link-invites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "invite",
      "id": "text",
      "role": "admin"
    }
  ]
}

Create a new organization invite

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

Responses

201

The organization invite has been created

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/link-invites

POST /v1/orgs/{organizationId}/link-invites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "role": "admin"
}

{
  "object": "invite",
  "id": "text",
  "role": "admin"
}

Deletes an organization invite.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

inviteIdstringRequired

The unique id of the invite

Responses

205

The organization invite has been deleted

default

Unexpected Error

application/json

delete

/orgs/{organizationId}/link-invites/{inviteId}

DELETE /v1/orgs/{organizationId}/link-invites/{inviteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update an organization invite.

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

inviteIdstringRequired

The unique id of the invite

Body

Responses

200

The organization invite has been updated

application/json

Responseone of

An invite link created in an organization

default

Unexpected Error

application/json

patch

/orgs/{organizationId}/link-invites/{inviteId}

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

{
  "role": "admin"
}

{
  "object": "invite",
  "id": "text",
  "role": "admin"
}

Upgrade an organization's billing plan

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

successReturnURLstringOptional

The app screen URL to bring the user back to after a successful checkout.

cancelReturnURLstringOptional

The app screen URL to bring the user back to after a canceled checkout.

Body

productstring · enumRequired

Name of the product

Possible values:

intervalstring · enumRequired

Interval for a billing subscription

Possible values:

reasonstringOptional

Reason that triggered the billing upgrade

modestring · enumOptional

Mode to use for the upgrade (default value is commit): - auto: user is redirect to checkout if possible, other a preview of the auto-upgrade is returned. - commit: a checkout session is returned or an auto-upgrade is done - preview: a preview invoice is always returned

Possible values:

Responses

200

application/json

Responseone of

default

Unexpected Error

application/json

post

/orgs/{organizationId}/billing

POST /v1/orgs/{organizationId}/billing HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "product": "free_2024",
  "interval": "monthly",
  "exclude": {
    "members": [
      "text"
    ],
    "sites": [
      "text"
    ]
  },
  "reason": "text",
  "mode": "auto"
}

{
  "result": "checkout",
  "sessionId": "text"
}

Preview a migration of an organization to new pricing.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

intervalstring · enumRequired

Interval for a billing subscription

Possible values:

productstring · enumRequired

The new product to upgrade to

Possible values:

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/billing/migrate

GET /v1/orgs/{organizationId}/billing/migrate?interval=monthly&product=free_2024 HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "invoice": {
    "amount": 1,
    "amountDueToday": 1,
    "customerBalance": 1,
    "remainingCustomerBalance": 1,
    "lines": [
      {
        "description": "text",
        "amount": 1,
        "periodStart": "2026-01-25T23:20:04.240Z",
        "periodEnd": "2026-01-25T23:20:04.240Z"
      }
    ]
  }
}

Migrate an organization's legacy billing plan to new pricing

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

intervalstring · enumRequired

Interval for a billing subscription

Possible values:

productstring · enumRequired

The new product to upgrade to

Possible values:

Responses

205

Organization migrated to new pricing

default

Unexpected Error

application/json

post

/orgs/{organizationId}/billing/migrate

POST /v1/orgs/{organizationId}/billing/migrate?interval=monthly&product=free_2024 HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Lists all legacy sites of an org and computes their new type and contributing features

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/billing/migrate/sites

GET /v1/orgs/{organizationId}/billing/migrate/sites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-to-migrate",
      "site": {
        "object": "site",
        "id": "text",
        "type": "basic",
        "title": "text",
        "hostname": "text",
        "basename": "text",
        "proxy": "text",
        "visibility": "public",
        "published": true,
        "siteSpaces": 1,
        "createdAt": "2026-01-25T23:20:04.240Z",
        "adaptiveContent": {
          "enabled": true
        },
        "ads": {
          "status": "pending",
          "submittable": true
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "published": "https://example.com"
        }
      },
      "newType": "basic",
      "features": [
        "sections"
      ]
    }
  ]
}

Get the billing portal for an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/billing/portal

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

{
  "url": "text"
}

Generates a billing invoice preview for organizations without an active subscription

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

intervalstring · enumRequired

Interval for a billing subscription

Possible values:

productstring · enumRequired

Name of the product

Possible values:

membersnumberOptional

The desired amount of members in the organization

premiumSitesnumberOptional

The desired amount of published premium sites

ultimateSitesnumberOptional

The desired amount of published ultimate sites

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/billing/preview

GET /v1/orgs/{organizationId}/billing/preview?interval=monthly&product=free_2024 HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "amount": 1,
  "amountDueToday": 1,
  "customerBalance": 1,
  "remainingCustomerBalance": 1,
  "lines": [
    {
      "description": "text",
      "amount": 1,
      "periodStart": "2026-01-25T23:20:04.240Z",
      "periodEnd": "2026-01-25T23:20:04.240Z"
    }
  ]
}

Send a request to ask the organization's admin to upgrade it.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

Responseobject

default

Unexpected Error

application/json

post

/orgs/{organizationId}/request_upgrade

POST /v1/orgs/{organizationId}/request_upgrade HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Search content in an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

querystring · max: 512Required

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/search

GET /v1/orgs/{organizationId}/search?query=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "title": "text",
      "pages": [
        {
          "id": "text",
          "title": "text",
          "path": "text",
          "sections": [
            {
              "id": "text",
              "title": "text",
              "path": "text",
              "body": "text",
              "urls": {
                "app": "https://example.com"
              }
            }
          ],
          "urls": {
            "app": "https://example.com"
          }
        }
      ]
    }
  ]
}

List organization spaces

get

Lists spaces for the specified organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/spaces

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "space",
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "visibility": "public",
      "createdAt": "2026-01-25T23:20:04.240Z",
      "updatedAt": "2026-01-25T23:20:04.240Z",
      "deletedAt": "2026-01-25T23:20:04.240Z",
      "editMode": "live",
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com",
        "published": "https://example.com",
        "public": "https://example.com",
        "icon": "https://example.com"
      },
      "organization": "text",
      "parent": "text",
      "gitSync": {
        "installationProvider": "github",
        "integration": "text",
        "url": "text",
        "updatedAt": "2026-01-25T23:20:04.240Z"
      },
      "visitorAuth": {
        "backend": "custom"
      },
      "revision": "text",
      "defaultLevel": "admin",
      "comments": 1,
      "changeRequests": 1,
      "changeRequestsOpen": 1,
      "changeRequestsDraft": 1,
      "permissions": {
        "access": true,
        "admin": true,
        "edit": true,
        "comment": true,
        "merge": true,
        "review": true
      }
    }
  ]
}

List organization collections

get

Lists collections for the specified organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

nestedbooleanOptional

If true, all nested collections will be listed

Default: true

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/collections

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "collection",
      "id": "text",
      "title": "text",
      "description": "text",
      "organization": "text",
      "parent": "text",
      "defaultLevel": "admin",
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com"
      },
      "permissions": {
        "admin": true,
        "create": true
      }
    }
  ]
}

Get the custom fields for spaces in an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/custom-fields

GET /v1/orgs/{organizationId}/custom-fields HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "title": "text",
      "description": "text",
      "type": "text",
      "placeholder": "text",
      "options": [
        "text"
      ],
      "createdAt": "2026-01-25T23:20:04.240Z",
      "updatedAt": "2026-01-25T23:20:04.240Z",
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Create a new custom field in an orgamization

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

namestring · min: 1 · max: 50RequiredPattern: ^[a-z_\-0-9]+$

typestring · enumRequiredPossible values:

titlestring · max: 100Optional

descriptionstring · max: 200Optional

placeholderstring · max: 100Optional

optionsstring[] · min: 1 · max: 50Optional

Responses

201

Custom field created

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/custom-fields

POST /v1/orgs/{organizationId}/custom-fields HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "name": "text",
  "type": "text",
  "title": "text",
  "description": "text",
  "placeholder": "text",
  "options": [
    "text"
  ]
}

{
  "id": "text",
  "name": "text",
  "title": "text",
  "description": "text",
  "type": "text",
  "placeholder": "text",
  "options": [
    "text"
  ],
  "createdAt": "2026-01-25T23:20:04.240Z",
  "updatedAt": "2026-01-25T23:20:04.240Z",
  "urls": {
    "location": "https://example.com"
  }
}

Get a custom field by its name

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

fieldNamestringRequired

The name of the custom field

Responses

200

application/json

404

No matching custom field found

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/custom-fields/{fieldName}

GET /v1/orgs/{organizationId}/custom-fields/{fieldName} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "title": "text",
  "description": "text",
  "type": "text",
  "placeholder": "text",
  "options": [
    "text"
  ],
  "createdAt": "2026-01-25T23:20:04.240Z",
  "updatedAt": "2026-01-25T23:20:04.240Z",
  "urls": {
    "location": "https://example.com"
  }
}

Delete a custom field in an organization

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

fieldNamestringRequired

The name of the custom field

Responses

204

Custom field has been deleted

default

Unexpected Error

application/json

delete

/orgs/{organizationId}/custom-fields/{fieldName}

DELETE /v1/orgs/{organizationId}/custom-fields/{fieldName} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a custom field in an organization

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

fieldNamestringRequired

The name of the custom field

Body

titlestring · max: 100Optional

descriptionstring · max: 200Optional

placeholderstring · max: 100Optional

optionsstring[] · min: 1 · max: 50Optional

Responses

200

application/json

default

Unexpected Error

application/json

patch

/orgs/{organizationId}/custom-fields/{fieldName}

PATCH /v1/orgs/{organizationId}/custom-fields/{fieldName} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "title": "text",
  "description": "text",
  "placeholder": "text",
  "options": [
    "text"
  ]
}

{
  "id": "text",
  "name": "text",
  "title": "text",
  "description": "text",
  "type": "text",
  "placeholder": "text",
  "options": [
    "text"
  ],
  "createdAt": "2026-01-25T23:20:04.240Z",
  "updatedAt": "2026-01-25T23:20:04.240Z",
  "urls": {
    "location": "https://example.com"
  }
}

List organization SAML providers

get

Lists SAML providers configured for the specified organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/saml

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "saml-provider",
      "id": "text",
      "label": "text",
      "ssoURL": "https://example.com",
      "entityID": "text",
      "certificate": "text",
      "defaultTeam": {
        "object": "team",
        "id": "text",
        "title": "text",
        "members": 1,
        "spaces": 1,
        "createdAt": "2026-01-25T23:20:04.240Z"
      },
      "defaultRole": "admin",
      "createdAt": "2026-01-25T23:20:04.240Z",
      "service": {
        "acsURL": "https://example.com",
        "startURL": "https://example.com",
        "entityID": "text"
      },
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Create a new SAML provider in an orgamization

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

labelstring · min: 1 · max: 30Required

entityIDstring · max: 1024Optional

certificatestring · max: 10000Optional

ssoURLstring · uriOptional

defaultTeamstringOptional

defaultRoleone ofOptional

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

string · enum | nullableOptional

Possible values:

Responses

201

SAML Provider created

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/saml

POST /v1/orgs/{organizationId}/saml HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "label": "text",
  "entityID": "text",
  "certificate": "text",
  "ssoURL": "https://example.com",
  "defaultTeam": "text",
  "defaultRole": "admin"
}

{
  "object": "saml-provider",
  "id": "text",
  "label": "text",
  "ssoURL": "https://example.com",
  "entityID": "text",
  "certificate": "text",
  "defaultTeam": {
    "object": "team",
    "id": "text",
    "title": "text",
    "members": 1,
    "spaces": 1,
    "createdAt": "2026-01-25T23:20:04.240Z"
  },
  "defaultRole": "admin",
  "createdAt": "2026-01-25T23:20:04.240Z",
  "service": {
    "acsURL": "https://example.com",
    "startURL": "https://example.com",
    "entityID": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

Get a SAML provider in an organization by its ID

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

samlProviderIdstringRequired

The unique id of the SAML provider

Responses

200

application/json

404

No matching provider found

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/saml/{samlProviderId}

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

{
  "object": "saml-provider",
  "id": "text",
  "label": "text",
  "ssoURL": "https://example.com",
  "entityID": "text",
  "certificate": "text",
  "defaultTeam": {
    "object": "team",
    "id": "text",
    "title": "text",
    "members": 1,
    "spaces": 1,
    "createdAt": "2026-01-25T23:20:04.240Z"
  },
  "defaultRole": "admin",
  "createdAt": "2026-01-25T23:20:04.240Z",
  "service": {
    "acsURL": "https://example.com",
    "startURL": "https://example.com",
    "entityID": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

Delete a SAML provider in an organization

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

samlProviderIdstringRequired

The unique id of the SAML provider

Responses

204

SAML provider has been deleted

default

Unexpected Error

application/json

delete

/orgs/{organizationId}/saml/{samlProviderId}

DELETE /v1/orgs/{organizationId}/saml/{samlProviderId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a SAML provider in an organization

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

samlProviderIdstringRequired

The unique id of the SAML provider

Body

labelstring · min: 1 · max: 30Optional

entityIDstring · max: 1024Optional

certificatestring · max: 10000Optional

ssoURLstring · uriOptional

defaultTeamstringOptional

defaultRoleone ofOptional

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

string · enum | nullableOptional

Possible values:

Responses

200

SAML provider has been updated

application/json

default

Unexpected Error

application/json

patch

/orgs/{organizationId}/saml/{samlProviderId}

PATCH /v1/orgs/{organizationId}/saml/{samlProviderId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "label": "text",
  "entityID": "text",
  "certificate": "text",
  "ssoURL": "https://example.com",
  "defaultTeam": "text",
  "defaultRole": "admin"
}

{
  "object": "saml-provider",
  "id": "text",
  "label": "text",
  "ssoURL": "https://example.com",
  "entityID": "text",
  "certificate": "text",
  "defaultTeam": {
    "object": "team",
    "id": "text",
    "title": "text",
    "members": 1,
    "spaces": 1,
    "createdAt": "2026-01-25T23:20:04.240Z"
  },
  "defaultRole": "admin",
  "createdAt": "2026-01-25T23:20:04.240Z",
  "service": {
    "acsURL": "https://example.com",
    "startURL": "https://example.com",
    "entityID": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

List organization SSO provider login information

get

Lists SSO login information configured for the specified organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/sso

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

{
  "items": [
    {
      "id": "text",
      "label": "text",
      "startURL": "https://example.com"
    }
  ]
}

Get all usage metrics for an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/usage

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

{
  "spaces": {
    "total": 1
  },
  "collections": {
    "total": 1
  },
  "sites": {
    "total": 1,
    "legacyBasic": 1,
    "legacyPremium": 1
  },
  "teams": {
    "total": 1
  },
  "members": {
    "total": 1,
    "seats": 1,
    "admin": 1,
    "create": 1,
    "edit": 1,
    "review": 1,
    "comment": 1,
    "read": 1,
    "guest": 1
  },
  "teamMembers": {
    "total": 1,
    "owner": 1,
    "member": 1
  }
}

Get collections usage metrics for an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/usage/collections

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

{
  "collections": {
    "total": 1
  }
}

Get spaces usage metrics for an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/usage/spaces

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

{
  "spaces": {
    "total": 1
  }
}

Get sites usage metrics for an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/usage/sites

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

{
  "sites": {
    "total": 1,
    "legacyBasic": 1,
    "legacyPremium": 1
  }
}

Get teams usage metrics for an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/usage/teams

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

{
  "teams": {
    "total": 1
  }
}

Get members usage metrics for an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/usage/members

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

{
  "members": {
    "total": 1,
    "seats": 1,
    "admin": 1,
    "create": 1,
    "edit": 1,
    "review": 1,
    "comment": 1,
    "read": 1,
    "guest": 1
  }
}

Get team members usage metrics for an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/usage/team-members

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

{
  "teamMembers": {
    "total": 1,
    "owner": 1,
    "member": 1
  }
}

Deprecated

List captures. Deprecated, use listSnippets instead.

get

List captures in an organization, newest first.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

contextstring · enumOptional

The context in which the item was captured

Possible values:

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/captures

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "title": "text",
      "context": "thread",
      "externalId": "text",
      "externalURL": "https://example.com",
      "createdAt": "2026-01-25T23:20:04.240Z",
      "stoppedAt": "2026-01-25T23:20:04.240Z",
      "editedAt": "2026-01-25T23:20:04.240Z",
      "events": {
        "terminal.command": 1,
        "speech": 1,
        "thread.message": 1
      },
      "contributors": [
        {
          "object": "integration",
          "name": "text",
          "version": 1,
          "title": "text",
          "description": "text",
          "summary": "text",
          "previewImages": [
            "text"
          ],
          "target": "all",
          "verified": true,
          "visibility": "public",
          "scopes": [
            "snippets:read"
          ],
          "categories": [
            "analytics"
          ],
          "blocks": [
            {
              "id": "text",
              "title": "text",
              "description": "text",
              "icon": "text",
              "urlUnfurl": [
                "text"
              ],
              "markdown": {
                "codeblock": "text",
                "body": "text"
              }
            }
          ],
          "contentSources": [
            {
              "id": "text",
              "title": "text",
              "description": "text",
              "icon": "text",
              "configuration": {
                "componentId": "text"
              }
            }
          ],
          "configurations": {
            "account": {
              "properties": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "title": "text",
                  "description": "text",
                  "type": "string",
                  "default": "text"
                }
              },
              "required": [
                "text"
              ]
            },
            "space": {
              "properties": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "title": "text",
                  "description": "text",
                  "type": "string",
                  "default": "text"
                }
              },
              "required": [
                "text"
              ]
            },
            "site": {
              "properties": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "title": "text",
                  "description": "text",
                  "type": "string",
                  "default": "text"
                }
              },
              "required": [
                "text"
              ]
            }
          },
          "externalLinks": [
            {
              "url": "https://example.com",
              "label": "text"
            }
          ],
          "owner": {
            "object": "organization",
            "id": "text",
            "title": "text",
            "createdAt": "2026-01-25T23:20:04.240Z",
            "emailDomains": [
              "text"
            ],
            "hostname": "text",
            "type": "business",
            "useCase": "internalDocs",
            "communityType": "nonProfit",
            "defaultRole": "admin",
            "defaultContent": {
              "type": "site",
              "site": "text"
            },
            "sso": true,
            "ai": true,
            "inviteLinks": true,
            "plan": "free_2024",
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "logo": "https://example.com"
            },
            "trialDecision": "downgrade",
            "customHostname": "text",
            "blocked": {
              "reason": "security"
            },
            "internal_isUsingSnippets": true,
            "internal_isOnNewTrial": true,
            "permissions": {
              "admin": true,
              "createContent": true
            }
          },
          "urls": {
            "location": "https://example.com",
            "icon": "https://example.com",
            "app": "https://example.com",
            "assets": "https://example.com",
            "publicEndpoint": "https://example.com"
          },
          "permissions": {
            "admin": true
          },
          "contentSecurityPolicy": "text"
        }
      ],
      "output": {
        "markdown": "text"
      },
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com"
      }
    }
  ]
}

Start a capture

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

titlestring · max: 100Optional

Optional title describing the capture

contextone ofRequired

string · enumOptionalPossible values:

externalIdstringOptional

ID in the original source of the capture.

externalURLstring · uriOptional

URL of the original source of the capture.

Responses

201

Capture started

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/captures

POST /v1/orgs/{organizationId}/captures HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "title": "text",
  "context": "thread",
  "externalId": "text",
  "externalURL": "https://example.com"
}

{
  "id": "text",
  "title": "text",
  "context": "thread",
  "externalId": "text",
  "externalURL": "https://example.com",
  "createdAt": "2026-01-25T23:20:04.240Z",
  "stoppedAt": "2026-01-25T23:20:04.240Z",
  "editedAt": "2026-01-25T23:20:04.240Z",
  "events": {
    "terminal.command": 1,
    "speech": 1,
    "thread.message": 1
  },
  "contributors": [
    {
      "object": "integration",
      "name": "text",
      "version": 1,
      "title": "text",
      "description": "text",
      "summary": "text",
      "previewImages": [
        "text"
      ],
      "target": "all",
      "verified": true,
      "visibility": "public",
      "scopes": [
        "snippets:read"
      ],
      "categories": [
        "analytics"
      ],
      "blocks": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "urlUnfurl": [
            "text"
          ],
          "markdown": {
            "codeblock": "text",
            "body": "text"
          }
        }
      ],
      "contentSources": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "configuration": {
            "componentId": "text"
          }
        }
      ],
      "configurations": {
        "account": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "space": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "site": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        }
      },
      "externalLinks": [
        {
          "url": "https://example.com",
          "label": "text"
        }
      ],
      "owner": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-01-25T23:20:04.240Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "type": "site",
          "site": "text"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trialDecision": "downgrade",
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isUsingSnippets": true,
        "internal_isOnNewTrial": true,
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true
      },
      "contentSecurityPolicy": "text"
    }
  ],
  "output": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com"
  }
}

Deprecated

Get a capture by its ID. Deprecated, use getSnippet instead.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

captureIdstringRequired

The unique id of a capture

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/captures/{captureId}

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

{
  "id": "text",
  "title": "text",
  "context": "thread",
  "externalId": "text",
  "externalURL": "https://example.com",
  "createdAt": "2026-01-25T23:20:04.240Z",
  "stoppedAt": "2026-01-25T23:20:04.240Z",
  "editedAt": "2026-01-25T23:20:04.240Z",
  "events": {
    "terminal.command": 1,
    "speech": 1,
    "thread.message": 1
  },
  "contributors": [
    {
      "object": "integration",
      "name": "text",
      "version": 1,
      "title": "text",
      "description": "text",
      "summary": "text",
      "previewImages": [
        "text"
      ],
      "target": "all",
      "verified": true,
      "visibility": "public",
      "scopes": [
        "snippets:read"
      ],
      "categories": [
        "analytics"
      ],
      "blocks": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "urlUnfurl": [
            "text"
          ],
          "markdown": {
            "codeblock": "text",
            "body": "text"
          }
        }
      ],
      "contentSources": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "configuration": {
            "componentId": "text"
          }
        }
      ],
      "configurations": {
        "account": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "space": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "site": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        }
      },
      "externalLinks": [
        {
          "url": "https://example.com",
          "label": "text"
        }
      ],
      "owner": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-01-25T23:20:04.240Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "type": "site",
          "site": "text"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trialDecision": "downgrade",
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isUsingSnippets": true,
        "internal_isOnNewTrial": true,
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true
      },
      "contentSecurityPolicy": "text"
    }
  ],
  "output": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com"
  }
}

Add events to a running capture

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

captureIdstringRequired

The unique id of a capture

Body

Responses

204

Events added

default

Unexpected Error

application/json

post

/orgs/{organizationId}/captures/{captureId}/events

POST /v1/orgs/{organizationId}/captures/{captureId}/events HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "events": [
    {
      "type": "terminal.command",
      "timestamp": "2026-01-25T23:20:04.240Z",
      "source": "text",
      "actor": {
        "name": "text"
      },
      "command": "text",
      "stdout": "text"
    }
  ]
}

No content

Stop a capture

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

captureIdstringRequired

The unique id of a capture

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

Body

objectOptional

Responses

200

Capture stopped

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/captures/{captureId}/stop

POST /v1/orgs/{organizationId}/captures/{captureId}/stop HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "capture": {
    "id": "text",
    "title": "text",
    "context": "thread",
    "externalId": "text",
    "externalURL": "https://example.com",
    "createdAt": "2026-01-25T23:20:04.240Z",
    "stoppedAt": "2026-01-25T23:20:04.240Z",
    "editedAt": "2026-01-25T23:20:04.240Z",
    "events": {
      "terminal.command": 1,
      "speech": 1,
      "thread.message": 1
    },
    "contributors": [
      {
        "object": "integration",
        "name": "text",
        "version": 1,
        "title": "text",
        "description": "text",
        "summary": "text",
        "previewImages": [
          "text"
        ],
        "target": "all",
        "verified": true,
        "visibility": "public",
        "scopes": [
          "snippets:read"
        ],
        "categories": [
          "analytics"
        ],
        "blocks": [
          {
            "id": "text",
            "title": "text",
            "description": "text",
            "icon": "text",
            "urlUnfurl": [
              "text"
            ],
            "markdown": {
              "codeblock": "text",
              "body": "text"
            }
          }
        ],
        "contentSources": [
          {
            "id": "text",
            "title": "text",
            "description": "text",
            "icon": "text",
            "configuration": {
              "componentId": "text"
            }
          }
        ],
        "configurations": {
          "account": {
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "title": "text",
                "description": "text",
                "type": "string",
                "default": "text"
              }
            },
            "required": [
              "text"
            ]
          },
          "space": {
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "title": "text",
                "description": "text",
                "type": "string",
                "default": "text"
              }
            },
            "required": [
              "text"
            ]
          },
          "site": {
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "title": "text",
                "description": "text",
                "type": "string",
                "default": "text"
              }
            },
            "required": [
              "text"
            ]
          }
        },
        "externalLinks": [
          {
            "url": "https://example.com",
            "label": "text"
          }
        ],
        "owner": {
          "object": "organization",
          "id": "text",
          "title": "text",
          "createdAt": "2026-01-25T23:20:04.240Z",
          "emailDomains": [
            "text"
          ],
          "hostname": "text",
          "type": "business",
          "useCase": "internalDocs",
          "communityType": "nonProfit",
          "defaultRole": "admin",
          "defaultContent": {
            "type": "site",
            "site": "text"
          },
          "sso": true,
          "ai": true,
          "inviteLinks": true,
          "plan": "free_2024",
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trialDecision": "downgrade",
          "customHostname": "text",
          "blocked": {
            "reason": "security"
          },
          "internal_isUsingSnippets": true,
          "internal_isOnNewTrial": true,
          "permissions": {
            "admin": true,
            "createContent": true
          }
        },
        "urls": {
          "location": "https://example.com",
          "icon": "https://example.com",
          "app": "https://example.com",
          "assets": "https://example.com",
          "publicEndpoint": "https://example.com"
        },
        "permissions": {
          "admin": true
        },
        "contentSecurityPolicy": "text"
      }
    ],
    "output": {
      "markdown": "text"
    },
    "urls": {
      "location": "https://example.com",
      "app": "https://example.com"
    }
  },
  "followupQuestions": [
    "text"
  ]
}

Lists snippets.

get

List snippets in an organization, newest first.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

sourcestringOptional

If specified, only snippets from the specified source will be returned.

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/snippets

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "organization": "text",
      "createdAt": "2026-01-25T23:20:04.240Z",
      "editedAt": "2026-01-25T23:20:04.240Z",
      "archived": true,
      "title": "text",
      "source": {
        "sourceId": "text",
        "name": "text",
        "externalId": "text",
        "externalUrl": "https://example.com"
      },
      "contributors": [
        {
          "object": "integration",
          "name": "text",
          "version": 1,
          "title": "text",
          "description": "text",
          "summary": "text",
          "previewImages": [
            "text"
          ],
          "target": "all",
          "verified": true,
          "visibility": "public",
          "scopes": [
            "snippets:read"
          ],
          "categories": [
            "analytics"
          ],
          "blocks": [
            {
              "id": "text",
              "title": "text",
              "description": "text",
              "icon": "text",
              "urlUnfurl": [
                "text"
              ],
              "markdown": {
                "codeblock": "text",
                "body": "text"
              }
            }
          ],
          "contentSources": [
            {
              "id": "text",
              "title": "text",
              "description": "text",
              "icon": "text",
              "configuration": {
                "componentId": "text"
              }
            }
          ],
          "configurations": {
            "account": {
              "properties": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "title": "text",
                  "description": "text",
                  "type": "string",
                  "default": "text"
                }
              },
              "required": [
                "text"
              ]
            },
            "space": {
              "properties": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "title": "text",
                  "description": "text",
                  "type": "string",
                  "default": "text"
                }
              },
              "required": [
                "text"
              ]
            },
            "site": {
              "properties": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "title": "text",
                  "description": "text",
                  "type": "string",
                  "default": "text"
                }
              },
              "required": [
                "text"
              ]
            }
          },
          "externalLinks": [
            {
              "url": "https://example.com",
              "label": "text"
            }
          ],
          "owner": {
            "object": "organization",
            "id": "text",
            "title": "text",
            "createdAt": "2026-01-25T23:20:04.240Z",
            "emailDomains": [
              "text"
            ],
            "hostname": "text",
            "type": "business",
            "useCase": "internalDocs",
            "communityType": "nonProfit",
            "defaultRole": "admin",
            "defaultContent": {
              "type": "site",
              "site": "text"
            },
            "sso": true,
            "ai": true,
            "inviteLinks": true,
            "plan": "free_2024",
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "logo": "https://example.com"
            },
            "trialDecision": "downgrade",
            "customHostname": "text",
            "blocked": {
              "reason": "security"
            },
            "internal_isUsingSnippets": true,
            "internal_isOnNewTrial": true,
            "permissions": {
              "admin": true,
              "createContent": true
            }
          },
          "urls": {
            "location": "https://example.com",
            "icon": "https://example.com",
            "app": "https://example.com",
            "assets": "https://example.com",
            "publicEndpoint": "https://example.com"
          },
          "permissions": {
            "admin": true
          },
          "contentSecurityPolicy": "text"
        }
      ],
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com"
      }
    }
  ]
}

Create a new snippet

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

objectOptional

Responses

201

Snippet created

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/snippets

POST /v1/orgs/{organizationId}/snippets HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "id": "text",
  "organization": "text",
  "createdAt": "2026-01-25T23:20:04.240Z",
  "editedAt": "2026-01-25T23:20:04.240Z",
  "archived": true,
  "title": "text",
  "source": {
    "sourceId": "text",
    "name": "text",
    "externalId": "text",
    "externalUrl": "https://example.com"
  },
  "contributors": [
    {
      "object": "integration",
      "name": "text",
      "version": 1,
      "title": "text",
      "description": "text",
      "summary": "text",
      "previewImages": [
        "text"
      ],
      "target": "all",
      "verified": true,
      "visibility": "public",
      "scopes": [
        "snippets:read"
      ],
      "categories": [
        "analytics"
      ],
      "blocks": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "urlUnfurl": [
            "text"
          ],
          "markdown": {
            "codeblock": "text",
            "body": "text"
          }
        }
      ],
      "contentSources": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "configuration": {
            "componentId": "text"
          }
        }
      ],
      "configurations": {
        "account": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "space": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "site": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        }
      },
      "externalLinks": [
        {
          "url": "https://example.com",
          "label": "text"
        }
      ],
      "owner": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-01-25T23:20:04.240Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "type": "site",
          "site": "text"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trialDecision": "downgrade",
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isUsingSnippets": true,
        "internal_isOnNewTrial": true,
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true
      },
      "contentSecurityPolicy": "text"
    }
  ],
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com"
  }
}

Get a snippet by its ID

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

snippetIdstringRequired

The unique id of a snippet

Responses

200

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/snippets/{snippetId}

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

{
  "id": "text",
  "organization": "text",
  "createdAt": "2026-01-25T23:20:04.240Z",
  "editedAt": "2026-01-25T23:20:04.240Z",
  "archived": true,
  "title": "text",
  "source": {
    "sourceId": "text",
    "name": "text",
    "externalId": "text",
    "externalUrl": "https://example.com"
  },
  "contributors": [
    {
      "object": "integration",
      "name": "text",
      "version": 1,
      "title": "text",
      "description": "text",
      "summary": "text",
      "previewImages": [
        "text"
      ],
      "target": "all",
      "verified": true,
      "visibility": "public",
      "scopes": [
        "snippets:read"
      ],
      "categories": [
        "analytics"
      ],
      "blocks": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "urlUnfurl": [
            "text"
          ],
          "markdown": {
            "codeblock": "text",
            "body": "text"
          }
        }
      ],
      "contentSources": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "configuration": {
            "componentId": "text"
          }
        }
      ],
      "configurations": {
        "account": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "space": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "site": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        }
      },
      "externalLinks": [
        {
          "url": "https://example.com",
          "label": "text"
        }
      ],
      "owner": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-01-25T23:20:04.240Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "type": "site",
          "site": "text"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trialDecision": "downgrade",
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isUsingSnippets": true,
        "internal_isOnNewTrial": true,
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true
      },
      "contentSecurityPolicy": "text"
    }
  ],
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com"
  }
}

Update an existing snippet.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

snippetIdstringRequired

The unique id of a snippet

Header parameters

If-Unmodified-Sincestring · date-timeOptional

If provided, the operation will be rejected if the underlying resource has been modified since the date provided in the header.

Body

titlestringOptional

A new title for the snippet.

Responses

200

application/json

default

Unexpected Error

application/json

put

/orgs/{organizationId}/snippets/{snippetId}

PUT /v1/orgs/{organizationId}/snippets/{snippetId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}

{
  "id": "text",
  "organization": "text",
  "createdAt": "2026-01-25T23:20:04.240Z",
  "editedAt": "2026-01-25T23:20:04.240Z",
  "archived": true,
  "title": "text",
  "source": {
    "sourceId": "text",
    "name": "text",
    "externalId": "text",
    "externalUrl": "https://example.com"
  },
  "contributors": [
    {
      "object": "integration",
      "name": "text",
      "version": 1,
      "title": "text",
      "description": "text",
      "summary": "text",
      "previewImages": [
        "text"
      ],
      "target": "all",
      "verified": true,
      "visibility": "public",
      "scopes": [
        "snippets:read"
      ],
      "categories": [
        "analytics"
      ],
      "blocks": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "urlUnfurl": [
            "text"
          ],
          "markdown": {
            "codeblock": "text",
            "body": "text"
          }
        }
      ],
      "contentSources": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "configuration": {
            "componentId": "text"
          }
        }
      ],
      "configurations": {
        "account": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "space": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "site": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        }
      },
      "externalLinks": [
        {
          "url": "https://example.com",
          "label": "text"
        }
      ],
      "owner": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-01-25T23:20:04.240Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "type": "site",
          "site": "text"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trialDecision": "downgrade",
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isUsingSnippets": true,
        "internal_isOnNewTrial": true,
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true
      },
      "contentSecurityPolicy": "text"
    }
  ],
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com"
  }
}

Delete a snippet by its ID.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

snippetIdstringRequired

The unique id of a snippet

Responses

200

No content

default

Unexpected Error

application/json

delete

/orgs/{organizationId}/snippets/{snippetId}

DELETE /v1/orgs/{organizationId}/snippets/{snippetId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Return possible snippet locations in an organization based on the current user.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

snippetIdstringRequired

The unique id of a snippet

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

spaceIdstringOptional

If specified, only locations in the given space will be returned. If not specified, GitBook will suggest spaces.

pageIdstringOptional

If specified, only locations under the given pageId will be returned. You must specify a spaceId too. If pageId is not specified, GitBook will suggest pages at the top level.

searchstringOptional

If specified, only locations matching the search query will be returned.

Responses

200

A paginated list of suggested snippet locations.

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/snippets/{snippetId}/move

GET /v1/orgs/{organizationId}/snippets/{snippetId}/move HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "aiPowered": true,
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2026-01-25T23:20:04.240Z",
        "updatedAt": "2026-01-25T23:20:04.240Z",
        "deletedAt": "2026-01-25T23:20:04.240Z",
        "editMode": "live",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "published": "https://example.com",
          "public": "https://example.com",
          "icon": "https://example.com"
        },
        "organization": "text",
        "parent": "text",
        "gitSync": {
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2026-01-25T23:20:04.240Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "permissions": {
          "access": true,
          "admin": true,
          "edit": true,
          "comment": true,
          "merge": true,
          "review": true
        }
      },
      "parentPage": "[Circular Reference]"
    }
  ]
}

Move a snippet into a destination. The snippet will be archived in the process.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

snippetIdstringRequired

The unique id of a snippet

Body

Responses

200

The snippet was successfully moved.

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/snippets/{snippetId}/move

POST /v1/orgs/{organizationId}/snippets/{snippetId}/move HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "target": {
    "space": "text",
    "position": {
      "parent": "text",
      "index": 1
    }
  }
}

{
  "page": {
    "id": "text",
    "title": "text",
    "emoji": "🎉",
    "icon": "gear",
    "createdAt": "2026-01-25T23:20:04.240Z",
    "updatedAt": "2026-01-25T23:20:04.240Z",
    "markdown": "text",
    "type": "document",
    "urls": {
      "app": "https://example.com"
    },
    "slug": "text",
    "path": "text",
    "description": "text",
    "documentId": "text",
    "pages": [
      {
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "icon": "gear",
        "createdAt": "2026-01-25T23:20:04.240Z",
        "updatedAt": "2026-01-25T23:20:04.240Z",
        "markdown": "text",
        "type": "document",
        "urls": {
          "app": "https://example.com"
        },
        "slug": "text",
        "path": "text",
        "description": "text",
        "documentId": "text",
        "pages": "[Circular Reference]",
        "git": {
          "oid": "text",
          "path": "text"
        },
        "layout": {
          "cover": true,
          "coverSize": "hero",
          "title": true,
          "description": true,
          "tableOfContents": true,
          "outline": true,
          "pagination": true
        },
        "cover": {
          "ref": {
            "kind": "file",
            "file": "text"
          },
          "yPos": 1
        },
        "hidden": false,
        "noIndex": false,
        "noRobotsIndex": false,
        "computed": "[Circular Reference]"
      }
    ],
    "git": {
      "oid": "text",
      "path": "text"
    },
    "layout": {
      "cover": true,
      "coverSize": "hero",
      "title": true,
      "description": true,
      "tableOfContents": true,
      "outline": true,
      "pagination": true
    },
    "cover": {
      "ref": {
        "kind": "file",
        "file": "text"
      },
      "yPos": 1
    },
    "hidden": false,
    "noIndex": false,
    "noRobotsIndex": false,
    "computed": {
      "integration": "text",
      "source": "text",
      "props": {
        "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
      },
      "dependsOn": [
        {
          "kind": "space",
          "space": "text"
        }
      ]
    }
  },
  "changeRequest": {
    "object": "change-request",
    "id": "text",
    "number": 1,
    "status": "draft",
    "subject": "text",
    "createdBy": {
      "object": "user",
      "id": "text",
      "displayName": "text",
      "email": "text",
      "photoURL": "text",
      "urls": {
        "location": "https://example.com"
      }
    },
    "createdAt": "2026-01-25T23:20:04.240Z",
    "updatedAt": "2026-01-25T23:20:04.240Z",
    "revision": "text",
    "revisionInitial": "text",
    "revisionMergedAncestor": "text",
    "revisionMerged": "text",
    "comments": 1,
    "outdated": true,
    "urls": {
      "app": "https://example.com",
      "location": "https://example.com"
    }
  }
}

Last updated 2 months ago

Was this helpful?

hashtagGet the list of organizations for the currently authenticated user

hashtagCreate an organization

hashtagGet an organization by its ID

hashtagDelete an organization by its ID

hashtagUpdate an organization by its ID

hashtagList all content in an organization

hashtagList organization members

hashtagGet specified organization member

hashtagDelete a member from an organization

hashtagUpdate specified organization member

hashtagUpdate organization member's "last seen at" timestamp.

hashtagSet a user as an SSO member of an organization

hashtagList organization teams

hashtagCreate organization team

hashtagGet specified organization team

hashtagDelete a team in an organization

hashtagUpdate specified organization team

hashtagList team members

hashtagUpdates members of an organization team

hashtagAdd or update a team membership

hashtagDelete members from a team

hashtagInvite users to a given organization based on a list of emails

hashtagUse an invite to join an organization.

hashtagList invite links to content in an organization

hashtagList invite links to an organization

hashtagCreate a new organization invite

hashtagDeletes an organization invite.

hashtagUpdate an organization invite.

hashtagUpgrade an organization's billing plan

hashtagPreview a migration of an organization to new pricing.

hashtagMigrate an organization's legacy billing plan to new pricing

hashtagLists all legacy sites of an org and computes their new type and contributing features

hashtagGet the billing portal for an organization

hashtagGenerates a billing invoice preview for organizations without an active subscription

hashtagSend a request to ask the organization's admin to upgrade it.

hashtagSearch content in an organization

hashtagList organization spaces

hashtagList organization collections

hashtagGet the custom fields for spaces in an organization

hashtagCreate a new custom field in an orgamization

hashtagGet a custom field by its name

hashtagDelete a custom field in an organization

hashtagUpdate a custom field in an organization

hashtagList organization SAML providers

hashtagCreate a new SAML provider in an orgamization

hashtagGet a SAML provider in an organization by its ID

hashtagDelete a SAML provider in an organization

hashtagUpdate a SAML provider in an organization

hashtagList organization SSO provider login information

hashtagGet all usage metrics for an organization

hashtagGet collections usage metrics for an organization

hashtagGet spaces usage metrics for an organization

hashtagGet sites usage metrics for an organization

hashtagGet teams usage metrics for an organization

hashtagGet members usage metrics for an organization

hashtagGet team members usage metrics for an organization

hashtagList captures. Deprecated, use listSnippets instead.

hashtagStart a capture

hashtagGet a capture by its ID. Deprecated, use getSnippet instead.

hashtagAdd events to a running capture

hashtagStop a capture

hashtagLists snippets.

hashtagCreate a new snippet

hashtagGet a snippet by its ID

hashtagUpdate an existing snippet.

hashtagDelete a snippet by its ID.

hashtagReturn possible snippet locations in an organization based on the current user.

hashtagMove a snippet into a destination. The snippet will be archived in the process.

Get the list of organizations for the currently authenticated user

Create an organization

Get an organization by its ID

Delete an organization by its ID

Update an organization by its ID

List all content in an organization

List organization members

Get specified organization member

Delete a member from an organization

Update specified organization member

Update organization member's "last seen at" timestamp.

Set a user as an SSO member of an organization

List organization teams

Create organization team

Get specified organization team

Delete a team in an organization

Update specified organization team

List team members

Updates members of an organization team

Add or update a team membership

Delete members from a team

Invite users to a given organization based on a list of emails

Use an invite to join an organization.

List invite links to content in an organization

List invite links to an organization

Create a new organization invite

Deletes an organization invite.

Update an organization invite.

Upgrade an organization's billing plan

Preview a migration of an organization to new pricing.

Migrate an organization's legacy billing plan to new pricing

Lists all legacy sites of an org and computes their new type and contributing features

Get the billing portal for an organization

Generates a billing invoice preview for organizations without an active subscription

Send a request to ask the organization's admin to upgrade it.

Search content in an organization

List organization spaces

List organization collections

Get the custom fields for spaces in an organization

Create a new custom field in an orgamization

Get a custom field by its name

Delete a custom field in an organization

Update a custom field in an organization

List organization SAML providers

Create a new SAML provider in an orgamization

Get a SAML provider in an organization by its ID

Delete a SAML provider in an organization

Update a SAML provider in an organization

List organization SSO provider login information

Get all usage metrics for an organization

Get collections usage metrics for an organization

Get spaces usage metrics for an organization

Get sites usage metrics for an organization

Get teams usage metrics for an organization

Get members usage metrics for an organization

Get team members usage metrics for an organization

List captures. Deprecated, use listSnippets instead.

Start a capture

Get a capture by its ID. Deprecated, use getSnippet instead.

Add events to a running capture

Stop a capture

Lists snippets.

Create a new snippet

Get a snippet by its ID

Update an existing snippet.

Delete a snippet by its ID.

Return possible snippet locations in an organization based on the current user.

Move a snippet into a destination. The snippet will be archived in the process.