For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get a user by its ID

Provides publicly available information about someone with a GitBook account.

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequired

The unique ID of the User

Responses
200

OK

application/json
objectstring · enumRequired

Type of Object, always equals to "user"

Possible values:
idstringRequired

Unique identifier for the user

displayNamestringRequired

Full name for the user

emailstringOptional

Email address of the user

photoURLstringOptional

URL of the user's profile picture

get/users/{userId}
GET /v1/users/{userId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "object": "user",
  "id": "text",
  "displayName": "text",
  "email": "text",
  "photoURL": "text",
  "urls": {
    "location": "https://example.com"
  }
}

Last updated

Was this helpful?

Powered by GitBook