Users
Retrieve and manage user information and profiles.
Was this helpful?
Retrieve and manage user information and profiles.
Was this helpful?
Was this helpful?
The Users API allows you to fetch data about GitBook users, including the authenticated account or other team members by ID. This is crucial for customizing permissions, personalizing content, or establishing user-specific flows.
Type of Object, always equals to "user"
Unique identifier for the user
Full name for the user
Email address of the user
URL of the user's profile picture
{
"object": "user",
"id": "text",
"displayName": "text",
"email": "text",
"photoURL": "text",
"urls": {
"location": "https://example.com"
}
}Returns details about the user associated with the authentication provided in the request's authorization header.
OK
User not found
GET /v1/user 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"
}
}Provides publicly available information about someone with a GitBook account.
The unique ID of the User
OK
User not found
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"
}
}Update a GitBook account's details.
The unique ID of the User
Full name for the user
The user has been updated
User not found
PATCH /v1/users/{userId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"displayName": "text",
"photoURL": "https://example.com"
}{
"object": "user",
"id": "text",
"displayName": "text",
"email": "text",
"photoURL": "text",
"urls": {
"location": "https://example.com"
}
}