For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create an organization

Available in MCP
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
withDefaultSitebooleanOptional

If true, also creates a default documentation site for the organization.

openapiUrlstringOptional

URL of an OpenAPI/Swagger specification to import and attach to the default site as a reference. Only used when withDefaultSite is true.

Body
titlestring · min: 2 · max: 255Required

Name of the organization

Pattern: \S.*\S
emailDomainsstring[]Optional
Responses
201

Organization created

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

{
  "title": "text",
  "emailDomains": [
    "text"
  ],
  "onboardingPreferences": {
    "source": "markdown-in-git",
    "audience": "public",
    "interests": [
      "adaptive-content"
    ]
  }
}
201

Organization created

{
  "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,
  "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,
    "creditsBundle": "none",
    "aiCreditAlertThreshold": 1
  },
  "mergeRules": {
    "type": "rules",
    "rules": [
      {
        "rule": "require_specific_reviewers",
        "users": [
          "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
  }
}

Last updated

Was this helpful?

Powered by GitBook