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

# List avatar templates

> Paginated list of a merchant's avatar templates (the admin-portal avatars list), scoped to the merchant from the JWT or the optional merchant_id override. Capped at 1000 records per page.



## OpenAPI

````yaml https://cool.jobmojito.com/functions/v1/openapi get /merchant-avatar-list
openapi: 3.1.0
info:
  title: JobMojito API
  version: 1.0.0
  description: >-
    Public API for JobMojito, served by Supabase Edge Functions. Authenticate
    with a Supabase JWT access token via the Authorization header.
servers:
  - url: https://cool.jobmojito.com/functions/v1
    description: Production
security: []
tags:
  - name: Interviews
    description: >-
      Create, configure and manage interview / coaching / assessment
      definitions.
  - name: Results
    description: >-
      Interview results, transcripts, reports, re-attempt requests and
      analytics.
  - name: Candidates
    description: List and manage candidates.
  - name: Knowledge base
    description: Upload documents used to generate knowledge-base interviews.
  - name: Resume & Form verification
    description: Pre-screen candidates from resumes and forms.
  - name: Admin
    description: >-
      Account administration — invite team/coaching users, manage sub-merchants
      and avatar templates.
paths:
  /merchant-avatar-list:
    get:
      tags:
        - Admin
      summary: List avatar templates
      description: >-
        Paginated list of a merchant's avatar templates (the admin-portal
        avatars list), scoped to the merchant from the JWT or the optional
        merchant_id override. Capped at 1000 records per page.
      parameters:
        - schema:
            type: string
            format: uuid
            description: >-
              Optional merchant to scope the results to. Honoured only when the
              caller is an admin or a sub-merchant operator; otherwise the
              merchant from the JWT is always used.
            example: 28106cba-1c27-4e53-b149-32113e5e8e31
          required: false
          name: merchant_id
          in: query
        - schema:
            type: string
            enum:
              - interactive_heygen
              - interactive_elevenlabs
              - offline_heygen
              - offline_elai
              - offline_synthesia
            description: Filter by avatar template type. Omit for all.
            example: interactive_heygen
          required: false
          name: type
          in: query
        - schema:
            type: string
            enum:
              - active
              - draft
              - archived
              - deleted
            description: >-
              Filter by status. Omit for all except archived (see
              include_archived).
            example: active
          required: false
          name: status
          in: query
        - schema:
            type: string
            description: Filter by platform language code.
          required: false
          name: mojito_language_code
          in: query
        - schema:
            type: string
            description: Case-insensitive search on template name or voice language name.
          required: false
          name: filter_text
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'false'
            description: Include archived templates (excluded by default).
            example: 'false'
          required: false
          name: include_archived
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'false'
            description: >-
              Also include public templates shared across merchants, in addition
              to this merchant's own.
            example: 'false'
          required: false
          name: include_public
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 50
            description: Maximum number of records to return (1–1000).
            example: 50
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 0
            description: Number of records to skip from the start of the result set.
            example: 0
          required: false
          name: offset
          in: query
      responses:
        '200':
          description: A page of avatar templates with pagination metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantAvatarListResponse'
        '401':
          description: Missing or invalid access token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Caller is not permitted to read this merchant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    MerchantAvatarListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Avatar template id.
              merchant_id:
                type: string
                nullable: true
                description: Owning merchant id.
              name:
                type: string
                nullable: true
                description: Template name.
              type:
                type: string
                nullable: true
                description: Avatar template type.
              status:
                type: string
                nullable: true
                description: Status (active/draft/archived/deleted).
              visibility:
                type: string
                nullable: true
                description: Visibility (public/merchant_…).
              mojito_language_code:
                type: string
                nullable: true
                description: Platform language code.
              video_voice_language_name:
                type: string
                nullable: true
                description: Voice language display name.
              media_url:
                type: string
                nullable: true
                description: Avatar media URL.
              background_url:
                type: string
                nullable: true
                description: Background image URL.
              background_blur:
                type: boolean
                nullable: true
                description: Whether the background is blurred.
              video_background_remove:
                type: boolean
                nullable: true
                description: Whether the video background is removed.
              video_avatar_image_url:
                type: string
                nullable: true
                description: Avatar still-image URL.
              video_avatar_aspect_ratio:
                type: string
                nullable: true
                description: Avatar aspect ratio.
              created_at:
                type: string
                nullable: true
                description: Creation timestamp (ISO 8601).
              updated_at:
                type: string
                nullable: true
                description: Last update timestamp (ISO 8601).
            required:
              - id
            additionalProperties:
              nullable: true
          description: The merchant's avatar templates for this page, newest-updated first.
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - data
        - pagination
    Error:
      type: object
      properties:
        error:
          type: string
          example: Field is required.
        name:
          type: string
          example: interview_result_id
      required:
        - error
    Pagination:
      type: object
      properties:
        total:
          type: integer
          description: Total matching records across all pages.
          example: 137
        limit:
          type: integer
          description: Page size used for this response.
          example: 50
        offset:
          type: integer
          description: Offset used for this response.
          example: 0
        has_more:
          type: boolean
          description: >-
            True when more records exist beyond this page (offset + returned <
            total).
          example: true
      required:
        - total
        - limit
        - offset
        - has_more
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Supabase JWT access token, passed as `Authorization: Bearer <token>`.'

````