Organizations
An organization in GitBook is the entity of a place that users, spaces, and collections belong to.
get
https://api.gitbook.com/v1
/orgs
Get the list of organizations for the currently authenticated user
Parameters
Query
page
string
Identifier of the page results to fetch.
limit
number
The number of results per page
Responses
200: OK
OK
default
Unexpected Error
get
https://api.gitbook.com/v1
/orgs/{organizationId}/collections
List organization collections
Lists collections for the specified organization.
Parameters
Path
organizationId*
string
The unique id of the organization
Query
page
string
Identifier of the page results to fetch.
limit
number
The number of results per page
nested
boolean
If true, all nested collections will be listed
Responses
200: OK
OK
default
Unexpected Error
get
https://api.gitbook.com/v1
/orgs/{organizationId}/spaces
List organization spaces
Lists spaces for the specified organization.
Parameters
Path
organizationId*
string
The unique id of the organization
Query
page
string
Identifier of the page results to fetch.
limit
number
The number of results per page
Responses
200: OK
OK
default
Unexpected Error
post
https://api.gitbook.com/v1
/orgs/{organizationId}/invites
Invite users to a given organization based on a list of emails
Parameters
Path
organizationId*
string
The unique id of the organization
Body
Example
Schema
{
"emails": [
"string",
{
"email": "string",
"role": "admin"
}
],
"sso": true
}
Responses
200: OK
OK
400: Bad Request
Bad Request
default
Unexpected Error
Last modified 1mo ago