Skip to main content
GET
/
characters
List characters
curl --request GET \
  --url https://rawugc.com/api/v1/characters \
  --header 'Authorization: Bearer <token>'
{
  "characters": [
    {
      "_id": "<string>",
      "username": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "videoPreviewUrl": "<string>",
      "type": "admin",
      "isActive": true,
      "createdAt": 123,
      "updatedAt": 123
    }
  ],
  "count": 123,
  "adminCount": 123,
  "userCount": 123
}

Authorizations

Authorization
string
header
required

Use your API key from the RawUGC dashboard. Include as: Authorization: Bearer YOUR_API_KEY

Response

Characters retrieved

characters
object[]
count
number
adminCount
number

Number of built-in admin characters

userCount
number

Number of user's custom characters