Get Avatars

Get Avatars

Query Parameters

search Search
style any
include_default any
page Page

Possible values: >= 1

Default value: 1

Page number

size Size

Possible values: >= 1 and <= 100

Default value: 50

Page size

Responses

• 200
• 422

---

Successful Response

application/json

Schema

Example (from schema)

---

Schema

items object[] required
Array [
name Name required
output_format object
style object
id uuid required
url uri required
Possible values: non-empty
source_type SourceTypes required
Possible values: [custom, default, exclusive, payable, promotion, designed, external, assembled, generated]
created_at date-time required
updated_at date-time required
thumbnail_url Thumbnail Url
outfit_id Outfit Id
head_id Head Id
lod object
vrm_url Vrm Url
vrm_updated_at Vrm Updated At
usdz_url Usdz Url
usdz_updated_at Usdz Updated At
halfbody_url Halfbody Url
facial_exp object
nft_url Nft Url
armature_rest_pose Armature Rest Pose
facial_morph_system Facial Morph System
provider Provider
]
total Total required
page Page required
size Size required
pages Pages

{
  "items": [
    {
      "name": "string",
      "output_format": "glb",
      "style": "phr",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "url": "string",
      "source_type": "custom",
      "created_at": "2025-05-28T07:18:23.319Z",
      "updated_at": "2025-05-28T07:18:23.319Z",
      "thumbnail_url": "string",
      "outfit_id": "string",
      "head_id": "string",
      "lod": {},
      "vrm_url": "string",
      "vrm_updated_at": "string",
      "usdz_url": "string",
      "usdz_updated_at": "string",
      "halfbody_url": "string",
      "facial_exp": {},
      "nft_url": "string",
      "armature_rest_pose": "string",
      "facial_morph_system": "string",
      "provider": "string"
    }
  ],
  "total": 0,
  "page": 0,
  "size": 0,
  "pages": 0
}

Validation Error

application/json

Schema

Example (from schema)

---

Schema

detail object[]
Array [
loc object[] required
Array [
anyOf
MOD1
MOD2
---
string
integer
]
msg Message required
type Error Type required
]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

GET /avatars

Authorization

name: OAuth2PasswordBearertype: oauth2flows: {
  "password": {
    "scopes": {},
    "tokenUrl": "login"
  }
}

Request

Base URL

https://api.unionavatars.com/v2

Security Scheme

OAuth2PasswordBearerAPIKeyHeader

Bearer Token

search — query

style — query

include_default — query

page — query

size — query

curl -L -X GET 'https://api.unionavatars.com/v2/avatars' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://api.unionavatars.com/v2/avatars' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://api.unionavatars.com/v2/avatars' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://api.unionavatars.com/v2/avatars' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://api.unionavatars.com/v2/avatars' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://api.unionavatars.com/v2/avatars' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://api.unionavatars.com/v2/avatars' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://api.unionavatars.com/v2/avatars' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://api.unionavatars.com/v2/avatars' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'