Collections
A collection in GitBook is the entity of a group that a space can belong to.
get
https://api.gitbook.com/v1
/collections/{collectionId}
Get the details about a collection using its ID
Parameters
Path
collectionId*
string
The unique id of the collection
Responses
200: OK
OK
default
Unexpected Error
get
https://api.gitbook.com/v1
/collections/{collectionId}/spaces
List all the spaces in a collection by its ID.
get
https://api.gitbook.com/v1
/collections/{collectionId}
Get the details about a collection using its ID
Parameters
Path
collectionId*
string
The unique id of the collection
Responses
200: OK
OK
default
Unexpected Error
get
https://api.gitbook.com/v1
/collections/{collectionId}/permissions/aggregate
List permissions for all users in a collection.
Parameters
Path
collectionId*
string
The unique id of the collection
Query
page
string
Identifier of the page results to fetch.
limit
number
The number of results per page
role
string
If defined, only members with this role will be returned.
Responses
200: OK
Listing of users who can access the collections.
default
Unexpected Error
Last modified 1mo ago