Organizations

An organization in GitBook is the entity of a place that users, spaces, and collections belong to.

GET organizations for current user

Get the list of organizations for the currently authenticated user

GEThttps://api.gitbook.com/v1/orgs

Authorization

user

Query parameters

Response

200default

OK

Body

application/json

nextobject

countnumber

Total count of objects in the list

items*array of Organization (object)

Request

JavaScriptCurl

const response = await fetch('https://api.gitbook.com/v1/orgs', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "next": {
    "page": "text"
  },
  "count": 0,
  "items": [
    {
      "object": "organization",
      "id": "text",
      "title": "text",
      "createdAt": "2024-04-26T08:42:46.858Z",
      "emailDomains": [
        "text"
      ],
      "type": "business",
      "useCase": "productDocs",
      "communityType": "nonProfit",
      "defaultRole": "admin",
      "defaultContent": {
        "type": "space",
        "space": "text"
      },
      "sso": false,
      "ai": false,
      "aiInsights": false,
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com",
        "logo": "https://example.com"
      }
    }
  ]
}

GET collections in an organization

List organization collections

Lists collections for the specified organization.

GEThttps://api.gitbook.com/v1/orgs/{organizationId}/collections

Authorization

user

Path parameters

organizationId*string

The unique id of the organization

Query parameters

Response

200default

OK

Body

application/json

nextobject

countnumber

Total count of objects in the list

items*array of Collection (object)

Request

JavaScriptCurl

const response = await fetch('https://api.gitbook.com/v1/orgs/{organizationId}/collections', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "next": {
    "page": "text"
  },
  "count": 0,
  "items": [
    {
      "object": "collection",
      "id": "text",
      "title": "text",
      "description": "text",
      "path": "text",
      "visibility": "public",
      "publishingType": "variants",
      "organization": "text",
      "parent": "text",
      "defaultLevel": "admin",
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com"
      }
    }
  ]
}

GET spaces in an organization

List organization spaces

Lists spaces for the specified organization.

GEThttps://api.gitbook.com/v1/orgs/{organizationId}/spaces

Authorization

user

Path parameters

organizationId*string

The unique id of the organization

Query parameters

Response

200default

OK

Body

application/json

nextobject

countnumber

Total count of objects in the list

items*array of Space (object)

Request

JavaScriptCurl

const response = await fetch('https://api.gitbook.com/v1/orgs/{organizationId}/spaces', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "next": {
    "page": "text"
  },
  "count": 0,
  "items": [
    {
      "object": "space",
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "visibility": "public",
      "createdAt": "2024-04-26T08:42:46.858Z",
      "updatedAt": "2024-04-26T08:42:46.858Z",
      "deletedAt": "2024-04-26T08:42:46.858Z",
      "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": "text",
        "operation": {
          "state": "running",
          "startedAt": "2024-04-26T08:42:46.858Z",
          "completedAt": "2024-04-26T08:42:46.858Z",
          "error": "text"
        },
        "url": "text",
        "updatedAt": "2024-04-26T08:42:46.858Z"
      },
      "visitorAuth": {
        "backend": "custom"
      },
      "revision": "text",
      "defaultLevel": "admin"
    }
  ]
}

GET spaces of the organization including Git Sync metadata

List organization spaces including Git sync metadata

Lists spaces including Git sync metadata for the specified organization.

GEThttps://api.gitbook.com/v1/orgs/{organizationId}/spaces/gitsync

Authorization

user

Path parameters

organizationId*string

The unique id of the organization

Query parameters

Response

200default

OK

Body

application/json

nextobject

countnumber

Total count of objects in the list

items*array of object

Request

JavaScriptCurl

const response = await fetch('https://api.gitbook.com/v1/orgs/{organizationId}/spaces/gitsync', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "next": {
    "page": "text"
  },
  "count": 0,
  "items": [
    {
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2024-04-26T08:42:46.858Z",
        "updatedAt": "2024-04-26T08:42:46.858Z",
        "deletedAt": "2024-04-26T08:42:46.858Z",
        "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": "text",
          "operation": {
            "state": "running",
            "startedAt": "2024-04-26T08:42:46.858Z",
            "completedAt": "2024-04-26T08:42:46.858Z",
            "error": "text"
          },
          "url": "text",
          "updatedAt": "2024-04-26T08:42:46.858Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin"
      },
      "gitSync": {
        "installationProvider": "text",
        "operation": {
          "state": "running",
          "startedAt": "2024-04-26T08:42:46.858Z",
          "completedAt": "2024-04-26T08:42:46.858Z",
          "error": "text"
        },
        "url": "text",
        "updatedAt": "2024-04-26T08:42:46.858Z"
      }
    }
  ]
}