GitBook Developer
GitBook Developer
Dashboard
Have a suggestion?
Contact support
Welcome
REST API v1
Overview
User and Organizations
Spaces
Analytics
Content
Search
Document Format
Overview
Blocks
Inlines
Marks
Powered by GitBook

Spaces

Get informations about spaces

The GitBook API is currently in beta phase. If you wish to be one of our testers, please contact our team at [email protected].

get
List Current User Spaces

https://$HOSTNAME/v1/user/spaces
List spaces created by the current user (this does not include spaces from organizations).
Request
Response
Request
​
Response
200: OK
{
    "items": [
        {
            "uid": "-Lzvo0nzaJUIPOUn92Fwh",
            "name": "Personal Knowledge Base",
            "baseName": "personal-knowledge-base",
            "private": false,
            "unlisted": false
        },
        {
            "uid": "-Lxa54df7gPokX5YxSsbSV",
            "name": "Homework",
            "baseName": "homework",
            "private": true,
            "unlisted": false
        }
    ]
}

get
List User or Organization Spaces

https://$HOSTNAME/v1/owners/:ownerID/spaces
List all spaces for an owner (owner can be either a user or an organization).
Request
Response
Request
Path Parameters
ownerID
required
string
Unique identifier of the owner
Response
200: OK
{
    "items": [
        {
            "uid": "-Lzvo0nzaJUIPOUn92Fwh",
            "name": "Human Resources",
            "baseName": "human-resources",
            "private": false,
            "unlisted": false
        },
        {
            "uid": "-Lxa54df7gPokX5YxSsbSV",
            "name": "Product",
            "baseName": "product",
            "private": false,
            "unlisted": false
        },
        {
            "uid": "-Lzvo0nzaKWfIUn92Fwh",
            "name": "Specific space",
            "baseName": "specific-space",
            "private": true,
            "unlisted": false
        }
    ]
}

get
Get Space

https://$HOSTNAME/spaces/:spaceID
Get all information about a specific space.
Request
Response
Request
Path Parameters
spaceID
required
string
Unique identifier of the space
Response
200: OK
{
    "uid": "-Lzvo0nzaKWfIUn92Fwh",
    "name": "Specific space",
    "baseName": "specific-space",
    "private": true,
    "unlisted": false
}
REST API v1 - Previous
User and Organizations
Next - REST API v1
Analytics
Last updated 8 months ago
Contents
get
List Current User Spaces
get
List User or Organization Spaces
get
Get Space