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

Search

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
Search content in a space

https://$HOSTNAME/v1/spaces/:space/search
Request
Response
Request
Path Parameters
space
required
string
ID of the space
Query Parameters
query
required
string
Query
Response
200: OK
{
    "results": [
        {
            "id": "pageID",
            "title": "Page Title",
            "sections": []
        },
        ...
    ]
}

get
Search content in an organization

https://$HOSTNAME/v1/owners/:owner/search
Request
Response
Request
Path Parameters
owner
required
string
ID of the owner
Response
200: OK
{
    "spaces": [
        {
            "id": "spaceID",
            "title": "Space Title",
            "pages": [
                {
                    "id": "pageID",
                    "title": "Page Title",
                    "sections": []
                },
                ...
            ]
        }
        ...
    ]
}
Previous
Assets
Next - Document Format
Overview
Last updated 7 months ago
Contents
get
Search content in a space
get
Search content in an organization