Concepts
Last updated
Last updated
Throughout the GitBook Integration Platform and it's documentation, there are different concepts, variables, and terms used as you continue to explore. Below you can find more information about these concepts and where to find them in the GitBook app.
<organizationId>A unique identifier of an Organization in GitBook. You can find the organization ID in the URL of any space you're in.
Alternatively, you can click the "Copy org ID" button when viewing your organization's settings.
Example
| URL | Organization ID |
|---|---|
https://app.gitbook.com/o/6DshSpVsoE/s/I6OHwf4UHU/ |
|
<spaceId>A unique identifier of a Space in GitBook. You can find the space ID in the URL of any space you're in.
Alternatively, you can click the "Copy space ID" button from the dropdown menu in the upper right corner when viewing a space.
Example
| URL | Space ID |
|---|---|
https://app.gitbook.com/o/6DshSpVsoE/s/I6OHwf4UHU/ |
|
<collectionId>A unique identifier of a collection in GitBook. You can find the collection ID in the URL of any collection page you're in.
Alternatively, you can click the "Copy collection ID" button from the dropdown menu in the upper right corner when viewing a collection.
Example
| URL | Collection ID |
|---|---|
https://app.gitbook.com/o/6DshSpVsoE/c/fj08dm76dh2 |
|
<userId>A unique identifier of a User in GitBook. You can find your User ID from calling the GET Current User endpoint in the GitBook API.
Alternatively, you can click the "Copy user ID" button from the dropdown when viewing a member within an organization.
gitbook-manifest.yamlA required file in a GitBook integration that contains information for publishing and developing your app. See the Configurations section for more info.
.gitbook-dev.yamlA required file in a GitBook integration containing information about developing your app. See the Development section for more info.
