---
title: "Get an avatar as an image."
method: GET
path: "/avatars/view/{avatarId}/{avatarFormat}"
tags: ["Avatars"]
---

# Get an avatar as an image.

`GET /avatars/view/{avatarId}/{avatarFormat}`

## Request

- Base URL: `https://passbolt.local`
- URL: `https://passbolt.local/avatars/view/{avatarId}/{avatarFormat}`
- Auth: none required
- TypeScript: <https://skmtc.dev/passbolt/apis/passbolt-api/docs/avatars/view/:avatarId/:avatarFormat/get.ts> (a function with typed inputs; its response is checked against the schema)

When the avatar doesn't exist, a placeholder image is returned instead.

## Path parameters

- `avatarId` string, uuid, required
- `avatarFormat` 'medium.jpg' | 'small.jpg', required

## Response `200`

Operation is successful

---

[API](https://skmtc.dev/passbolt/apis/passbolt-api.md) - [All operations](https://skmtc.dev/passbolt/apis/passbolt-api/llms.txt) - [OpenAPI document](https://skmtc.dev/passbolt/apis/passbolt-api/revisions/8d72215e2274?raw)