Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Latest version

Get user avatar

get
https://api.box.com/2.0
/users/:user_id/avatar

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Retrieves an image of a the user's avatar.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The ID of the user.

Response

image/jpg

When an avatar can be found for the user the image data will be returned in the body of the response.

application/jsonClient error

An unexpected client error.

get
Get user avatar
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/users/12345/avatar" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.avatars.getUserAvatar(user.id);
Python v10
client.avatars.get_user_avatar(user.id)
.NET v10
await client.Avatars.GetUserAvatarAsync(userId: user.Id);
Swift v10
try await client.avatars.getUserAvatar(userId: user.id, downloadDestinationUrl: destinationPath)
Java v10
client.getAvatars().getUserAvatar(user.getId())
.NET v6
await client.Avatars.GetUserAvatarAsync(userId: user.Id);
Node v4
await client.avatars.getUserAvatar(user.id);