Avatar API

Use this API to interact with user avatars.

Get details on an account avatar

Gets the URL of an account avatar associated with a given public email address. This endpoint does not require authentication.

If successful, returns the URL of the avatar.
If no account is associated with the given email address, returns results from external avatar services.
If the public visibility is restricted and the request isn’t authenticated, returns 403 Forbidden.

GET /avatar?email=admin@example.com

Parameters:

Attribute	Type	Required	Description
`email`	string	yes	Public email address of the account.
`size`	integer	no	Single pixel dimension. Only used for avatar lookups at `Gravatar` or a configured `Libravatar` server.

Example request:

curl --request GET \
  --url "https://gitlab.example.com/api/v4/avatar?email=admin@example.com&size=32"

Example response:

{
  "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=64&d=identicon"
}

Edit this page to fix an error or add an improvement in a merge request.

Create an issue to suggest an improvement to this page.

Create an issue if there's something you don't like about this feature.

Propose functionality by submitting a feature request.

View pricing to see all GitLab tiers and features, or to upgrade.

Try GitLab for free with access to all features for 30 days.

If you didn't find what you were looking for, search the docs.

If you want help with something specific and could use community support, post on the GitLab forum.

For problems setting up or using this feature (depending on your GitLab subscription).