Users: getProfileImage

Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded.

The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.

If successful, the response returns a 200 - OK and the user profile image.

Request

HTTP request

GET /v2/accounts/{accountId}/users/{userId}/profile/image

Parameters

Parameter name Value Description
Path parameters
accountId string

The external account number (int) or account ID Guid.

userId string

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Optional query parameters
encoding string

Responses

image/gif

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Users::getProfileImage

Definitions Expand All | Collapse All

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.