> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jogg.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Photo Avatars

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


Retrieve the list of your photo avatars created from uploaded photos.

## Example Usage

```bash theme={null}
curl --request GET \
  --url 'https://api.jogg.ai/v2/avatars/photo_avatars' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Related Guides

<CardGroup cols={2}>
  <Card title="Create Photo Avatar Guide" href="/api-reference/v2/API Documentation/CreatePhotoAvatar">
    Learn how to create photo avatars
  </Card>
</CardGroup>


## OpenAPI

````yaml GET /v2/avatars/photo_avatars
openapi: 3.0.1
info:
  title: JoggAI OpenAPI v2
  description: >
    JoggAI OpenAPI v2 provides a comprehensive suite of endpoints for creating
    and managing AI-powered video content.


    ## Authentication

    All API requests require authentication using an API key provided in the
    `x-api-key` header.


    ## Base URL

    Production: https://api.jogg.ai/v2


    ## Rate Limiting

    API calls are subject to rate limiting based on your subscription plan.


    ## Error Handling

    All endpoints return standard HTTP status codes along with detailed error
    messages in the response body.
  version: 2.0.0
  license:
    name: MIT
servers:
  - url: https://api.jogg.ai
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: Video
    description: Video creation and management operations
  - name: Avatar
    description: Avatar management and creation operations
  - name: Voice
    description: Voice and timbre management operations
  - name: Asset
    description: Asset management including music, scripts, and uploads
  - name: Template
    description: Template management operations
  - name: Product
    description: Product management operations
  - name: User
    description: User account operations
  - name: Webhook
    description: Webhook endpoint management for event notifications
paths:
  /v2/avatars/photo_avatars:
    get:
      tags:
        - Avatar
      summary: Get Photo Avatar List
      description: |
        Retrieve list of user's photo avatars.
        Returns user's photo-based avatar collection with filtering options.
      parameters:
        - $ref: '#/components/parameters/PageParam'
        - $ref: '#/components/parameters/PageSizeParam'
        - name: name
          in: query
          description: Avatar name filter
          schema:
            type: string
        - name: status
          in: query
          description: Status filter
          schema:
            type: string
            enum:
              - processing
              - completed
              - failed
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BaseResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          avatars:
                            type: array
                            description: List of photo avatars
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  description: Avatar ID
                                  example: 123
                                name:
                                  type: string
                                  description: Avatar name
                                  example: My Photo Avatar
                                cover_url:
                                  type: string
                                  description: Cover URL
                                  format: uri
                                  example: https://example.com/cover.jpg
                                status:
                                  type: integer
                                  description: Avatar status
                                  enum:
                                    - 0
                                    - 1
                                    - 2
                                  example: 1
                                fail_msg:
                                  type: string
                                  description: Failure message (if failed)
                                  example: ''
components:
  parameters:
    PageParam:
      name: page
      in: query
      description: Page number for pagination
      schema:
        type: integer
        minimum: 1
        default: 1
        example: 1
    PageSizeParam:
      name: page_size
      in: query
      description: Number of items per page
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
        example: 10
  schemas:
    BaseResponse:
      type: object
      required:
        - code
        - msg
      properties:
        code:
          type: integer
          description: |
            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
          example: 0
        msg:
          type: string
          description: Response message
          example: Success
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Obtain your key from the JoggAI dashboard.

````