User and Organizations

Get informations about users and organizations

The GitBook API is currently in beta phase. If you wish to be one of our testers, please contact our team at support@gitbook.com.
get
Get Current User
https://$HOSTNAME/v1/user
Get the currently authenticated user.
Request
Response
Request
​
Response
200: OK
Returns the current user properties.
{
    "uid": "520LEkmK9iOpQfC3xP7Qe4vWt7E3",
    "kind": "user",
    "title": "John",
    "baseDomain": "john"
}
get
List Current User Organizations
https://$HOSTNAME/v1/orgs
List the current user's organizations.
Request
Response
Request
​
Response
200: OK
Returns a list of organizations and their properties.
{
    "items": [
        {
            "uid": "-LvAGCSXSmmX2-R7dVhO",
            "kind": "org",
            "title": "Acme",
            "baseDomain": "acme"
        },
        {
            "uid": "-LvGNG0NJ3kKWPcuBs9G",
            "kind": "org",
            "title": "Panda Org",
            "baseDomain": "panda-org"
        },
        {
            "uid": "-LwYvEZ6uQZBBtJXOSgS",
            "kind": "org",
            "title": "Open-Source Project",
            "baseDomain": "open-source-project"
        }
    ]
}
get
Get User or Organization
https://$HOSTNAME/v1/owners/:ownerID
Gets information about a specific user or organization.
Request
Response
Request
Path Parameters
ownerID
required
string
A unique identifier representing an User or Organization.
Response
200: OK
// For an User
{
    "uid": "520LEkmK9iOpQfC3xP7Qe4vWt7E3",
    "kind": "user",
    "title": "John",
    "baseDomain": "john"
}
​
// For an Organization
{
    "uid": "-LvAGCSXSmmX2-R7dVhO",
    "kind": "org",
    "title": "Acme",
    "baseDomain": "acme"
}

REST API v1 - Previous

Overview

Next - REST API v1

Spaces

Last updated 6 months ago

User and Organizations

getGet Current User

getList Current User Organizations

getGet User or Organization

get
Get Current User

get
List Current User Organizations

get
Get User or Organization