Organizations

Manage your organizations and group your members, spaces, and resources under one collaborative structure.

The Organizations API provides a robust way to handle the administrative structure of your GitBook workspace. By creating and configuring organizations, you can group multiple users, spaces, and collections, simplifying your permission management and fostering efficient collaboration for teams of any size.

The Organization object

Attributes

objectstring · enumRequired

Type of Object, always equals to "organization"

Possible values:

idstringRequired

Unique identifier for the organization

titlestring · min: 2 · max: 255Required

Name of the organization

Pattern: \S.*\S

createdAtstring · date-timeRequired

emailDomainsstring[]Required

hostnamestring · min: 3 · max: 32Optional

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

typestring · enumRequiredPossible values:

useCasestring · enumOptionalPossible values:

communityTypestring · enumOptionalPossible values:

defaultRolestring · enum · nullableOptional

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

Possible values:

defaultContentone ofOptional

The default content for the organization

ssobooleanOptional

Whether SSO is enforced organization-wide

aibooleanOptional

If true, the organization is configured to use all our AI features.

aiPausedbooleanOptional

Whether AI features have been paused automatically due to lack of AI credits.

inviteLinksbooleanRequired

If true, invite links are enabled for this organization.

auditLogsbooleanOptional

Whether audit logs can currently be accessed for this organization.

planstring · enumRequired

Name of the product

Possible values:

mergeRulesone ofRequired

or

supportCostone ofOptional

Support cost set by the organization, only available for org members.

or

customHostnamestringOptional

Custom hostname linked to this organization

The Organization object

{
  "object": "organization",
  "id": "text",
  "title": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "emailDomains": [
    "text"
  ],
  "hostname": "text",
  "type": "business",
  "useCase": "internalDocs",
  "communityType": "nonProfit",
  "defaultRole": "admin",
  "defaultContent": {
    "type": "site",
    "site": "text"
  },
  "sso": true,
  "ai": true,
  "aiSettings": {
    "ai-agent": false,
    "ai-assistant": false,
    "ai-broken-links": false,
    "ai-content-gap": false,
    "ai-insight": false,
    "ai-import": false,
    "ai-platform": false,
    "ai-style-guide": false,
    "ai-translation": false,
    "aiCreditAlertThreshold": 1,
    "aiCreditPauseEnabled": true,
    "aiAlertNotificationAlertId": "text",
    "aiPauseNotificationAlertId": "text"
  },
  "aiPaused": true,
  "inviteLinks": true,
  "auditLogs": true,
  "plan": "free_2024",
  "billing": {
    "interval": "monthly",
    "endDate": "2026-01-01T00:00:00.000Z",
    "hasPaymentFailed": true,
    "canCheckout": true,
    "isScheduledToCancel": true,
    "pricing": {
      "members": {
        "plus_2024": {
          "monthly": 1,
          "yearly": 1
        },
        "pro_2024": {
          "monthly": 1,
          "yearly": 1
        }
      },
      "sites": {
        "premium": {
          "monthly": 1,
          "yearly": 1
        },
        "ultimate": {
          "monthly": 1,
          "yearly": 1
        }
      }
    },
    "usageAddons": {
      "ANY_ADDITIONAL_PROPERTY": {
        "enabled": true
      }
    },
    "minUsers": 1,
    "maxUsers": 1,
    "minPremiumSites": 1,
    "maxPremiumSites": 1,
    "minUltimateSites": 1,
    "maxUltimateSites": 1,
    "paidMembers": 1,
    "paidPremiumSites": 1,
    "paidUltimateSites": 1,
    "canChangeInterval": true,
    "canUseSAML": true,
    "canUseAI": true,
    "creditsBundle": "none",
    "aiCreditAllowance": 1,
    "aiCreditRollover": 1
  },
  "mergeRules": {
    "type": "rules",
    "rules": [
      {
        "rule": "require_specific_reviewers",
        "users": [
          "text"
        ]
      }
    ]
  },
  "supportCost": {
    "perTicket": 1,
    "currency": "text"
  },
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "logo": "https://example.com"
  },
  "trial": {
    "status": "notapplicable",
    "count": 1,
    "endDate": "2026-01-01T00:00:00.000Z",
    "decision": "downgrade"
  },
  "customHostname": "text",
  "blocked": {
    "source": "backoffice",
    "reason": "text"
  },
  "internal_billingMigration": {
    "deadline": "2026-01-01T00:00:00.000Z",
    "discountPercent": 1,
    "discountEndDate": "2026-01-01T00:00:00.000Z"
  },
  "permissions": {
    "view": true,
    "access": true,
    "admin": true,
    "ownTeam": true,
    "createContent": true,
    "createOpenAPISpec": true,
    "viewBilling": true,
    "listMembers": true,
    "listTeams": true,
    "listIntegrations": true,
    "listInstallations": true,
    "installIntegration": true
  }
}