Skip to main content
GET
/
merchant-avatar-list
List avatar templates
curl --request GET \
  --url https://cool.jobmojito.com/functions/v1/merchant-avatar-list \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "merchant_id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "status": "<string>",
      "visibility": "<string>",
      "mojito_language_code": "<string>",
      "video_voice_language_name": "<string>",
      "media_url": "<string>",
      "background_url": "<string>",
      "background_blur": true,
      "video_background_remove": true,
      "video_avatar_image_url": "<string>",
      "video_avatar_aspect_ratio": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "pagination": {
    "total": 137,
    "limit": 50,
    "offset": 0,
    "has_more": true
  }
}

Authorizations

​
Authorization
string
header
required

Supabase JWT access token, passed as Authorization: Bearer <token>.

Query Parameters

​
merchant_id
string<uuid>

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"

​
type
enum<string>

Filter by avatar template type. Omit for all.

Available options:
interactive_heygen,
interactive_elevenlabs,
offline_heygen,
offline_elai,
offline_synthesia
Example:

"interactive_heygen"

​
status
enum<string>

Filter by status. Omit for all except archived (see include_archived).

Available options:
active,
draft,
archived,
deleted
Example:

"active"

​
mojito_language_code
string

Filter by platform language code.

​
filter_text
string

Case-insensitive search on template name or voice language name.

​
include_archived
enum<string>
default:false

Include archived templates (excluded by default).

Available options:
true,
false
Example:

"false"

​
include_public
enum<string>
default:false

Also include public templates shared across merchants, in addition to this merchant's own.

Available options:
true,
false
Example:

"false"

​
limit
integer
default:50

Maximum number of records to return (1–1000).

Required range: 1 <= x <= 1000
Example:

50

​
offset
integer | null
default:0

Number of records to skip from the start of the result set.

Required range: x >= 0
Example:

0

Response

A page of avatar templates with pagination metadata.

​
data
object[]
required

The merchant's avatar templates for this page, newest-updated first.

​
pagination
object
required