Users
Retrieve and manage user information and profiles.
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
The User object
Returns details about the user associated with the authentication provided in the request's authorization header.
OK
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
User not found
Generates a JWT for the authenticated user. This token is used by the frontend notifications client to access user endpoints.
The notifications service User JWT
Temporary access token to authenticate with the API
The notifications service User JWT
Provides publicly available information about someone with a GitBook account.
The unique ID of the User
OK
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
User not found
Update a GitBook account's details.
The unique ID of the User
Full name for the user
The user has been updated
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
User not found
Last updated
Was this helpful?