Organizations
Manage organizations and group users, spaces, and collections.
The unique id of the organization
Name of the organization
Default hostname for the organization's public content, e.g. .gitbook.io
The role of a member in an organization, null for guests
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Lists members for the specified organization.
The unique id of the organization
Identifier of the page results to fetch.
The number of results per page
An order for the items in the list
The Role to filter the member list by
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
A query to filter the member list (displayName and email)
The property to sort the results by. When sorting by lastSeenAt, only active members will be listed.
Updates a specific member in an organization.
The unique id of the organization
The unique ID of the User
The role of a member in an organization, null for guests
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Lists teams for the specified organization.
The unique id of the organization
Identifier of the page results to fetch.
The number of results per page
The unique identifier of a member of the organization. Only teams they can manage will be returned.
If provided, only teams whose name contains the given parameter will be returned. Case insensitive.
Creates a team in the specified organization.
The unique id of the organization
Title of the team
A list of organization member identifiers
Updates a specific team in an organization.
The unique id of the organization
The unique ID of the Team
Title of the team
Lists members, and their roles, for the specified organization team.
The unique id of the organization
The unique ID of the Team
Identifier of the page results to fetch.
The number of results per page
Updates members of an organization team, either adding or removing them. If a the same user is included as both an add and a remove, they will be removed from the team.
The unique id of the organization
The unique ID of the Team
A user to add. It can either be a user ID or an email.
A user to remove. It can either be a user ID or an email.
No body
Add or updates member in the specified organization team.
The unique id of the organization
The unique ID of the Team
The unique ID of the User
"The role of a team member. "owner": Can manage team members. "member": Is a member of the team.
No body
Deletes member from the specified organization team.
The unique id of the organization
The unique ID of the Team
The unique ID of the User
No body
The unique id of the organization
Default role to set on newly invited members.
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
If true, invites the user as an SSO user of the organization. Defaults to false.
The unique id of the organization
Identifier of the page results to fetch.
The number of results per page
The unique id of the organization
The unique id of the invite
Update role of an organization invite
Update level of an organization content invite
The unique id of the organization
Identifier of the page results to fetch.
The number of results per page
Lists spaces for the specified organization.
The unique id of the organization
Identifier of the page results to fetch.
The number of results per page
The unique id of the organization
Unicode codepoint or character of the emoji
🎉
Private spaces are no longer supported by GitBook.
ID of a parent collection
Lists collections for the specified organization.
The unique id of the organization
Identifier of the page results to fetch.
The number of results per page
If true, all nested collections will be listed
The unique id of the organization
Identifier of the page results to fetch.
The number of results per page
The unique id of the organization
^[a-z_\-0-9]+$
The unique id of the organization
The name of the custom field
Lists SAML providers configured for the specified organization.
The unique id of the organization
Identifier of the page results to fetch.
The number of results per page
The unique id of the organization
The role of a member in an organization, null for guests
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
The unique id of the organization
The unique id of the SAML provider
The role of a member in an organization, null for guests
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Generate a pre-signed URL that can be used to upload a file to storage
The unique id of the organization
The unique id of the organization
The human-readable font-family name used in CSS (e.g., "Open Sans", "Playfair Display").
Array of font faces specifying weights and their corresponding storage keys. At least one font face with weight 400 (regular) must be provided.
The unique id of the organization
The unique ID of a font
The human-readable font-family name used in CSS (e.g., "Open Sans", "Playfair Display").
Array of font faces specifying weights and their corresponding storage keys. Passing null as the storage key will remove that weight.
Was this helpful?