Organizations

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

Last updated 8 days ago

Was this helpful?

List organization collections

Lists collections for the specified organization.

get

/orgs/{organizationId}/collections

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber

The number of results per page

nestedboolean

If true, all nested collections will be listed

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

default

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

List organization spaces

Lists spaces for the specified organization.

get

/orgs/{organizationId}/spaces

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber

The number of results per page

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

default

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

Get the list of organizations for the currently authenticated user

get

/orgs

Authorizations

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber

The number of results per page

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

default

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "title": "text",
      "createdAt": "2025-02-15T13:20:33.696Z",
      "emailDomains": [
        "text"
      ],
      "hostname": "text",
      "type": "business",
      "useCase": "internalDocs",
      "communityType": "nonProfit",
      "defaultRole": "admin",
      "defaultContent": {
        "type": "site",
        "site": "text"
      },
      "plan": "free_2024",
      "id": "text",
      "sso": true,
      "ai": true,
      "inviteLinks": true,
      "customHostname": "text",
      "internal_isOnNewTrial": true,
      "object": "organization",
      "trialDecision": "downgrade",
      "blocked": {
        "reason": "security"
      },
      "internal_billingMigration": {
        "deadline": "2025-02-15T13:20:33.696Z",
        "discountPercent": 1,
        "discountEndDate": "2025-02-15T13:20:33.696Z"
      },
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com",
        "logo": "https://example.com"
      },
      "permissions": {
        "admin": true,
        "createContent": true
      }
    }
  ]
}