API Reference

Get Profile Picture Of User

GET/api/v2/admin/users/{userId}/profilePicture

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.

Path parameters

userId

string

The ID of a Foundry Group or User.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Response body

body

string

The user's profile picture in binary format. The format is the original format uploaded by the user. The response will contain a Content-Type header that can be used to identify the media type.

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/admin/users/f05f8da4-b84c-4fca-9c77-8af0b13d11de/profilePicture?preview=true"