---
title: "Get Photo Avatar List"
method: GET
path: "/v2/avatars/photo_avatars"
tags: ["Avatar"]
---

# Get Photo Avatar List

`GET /v2/avatars/photo_avatars`

## Request

- Base URL: `https://api.jogg.ai`
- URL: `https://api.jogg.ai/v2/avatars/photo_avatars`
- Auth: API key in header `x-api-key`

Retrieve list of user's photo avatars.
Returns user's photo-based avatar collection with filtering options.

## Query parameters

- `page` integer
- `page_size` integer
- `name` string
- `status` 'processing' | 'completed' | 'failed'

## Response `200`

Success

- object
  - `code` integer, required: Business status code: * 0 - Success * 10104 - Record not found * 10105 - Invalid API key * 18020 - Insufficient credit * 18025 - No permission to call APIs * 40000 - Parameter error * 50000 - System error
  - `msg` string, required: Response message
  - `data` object
    - `avatars` object[]: List of photo avatars
      - `id` integer: Avatar ID
      - `name` string: Avatar name
      - `cover_url` string, uri: Cover URL
      - `status` 0 | 1 | 2: Avatar status
      - `fail_msg` string: Failure message (if failed)

---

[API](https://skmtc.dev/jogg/apis/joggai-openapi-v2.md) - [All operations](https://skmtc.dev/jogg/apis/joggai-openapi-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/jogg/apis/joggai-openapi-v2/revisions/22021dd81934?raw)