---
title: "List mascots"
method: GET
path: "/v1/mascots"
tags: ["Mascots"]
---

# List mascots

`GET /v1/mascots`

## Request

- Base URL: `https://api.masko.ai`
- URL: `https://api.masko.ai/v1/mascots`
- Auth: HTTP bearer

Returns all mascots owned by the authenticated user, paginated. A mascot is a single mascot character with its own style, references, and items. No credit cost.

## Query parameters

- `limit` number: Page size. 1 to 100. Defaults to 50.
- `offset` number, nullable: Number of records to skip. Defaults to 0.
- `cursor` string: Opaque next_cursor from the previous page. Use instead of offset.
- `project_id` string, uuid: Filter to this project.
- `type` string: Filter by type, e.g. "mascot".

## Response `200`

List of mascots

- CollectionListResponse
  - `data` Collection[], required
    - `object` 'mascot': Resource type. Always "mascot".
    - `id` string, uuid, required
    - `name` string, required
    - `type` string, required
    - `project_id` string, uuid
    - `config` object
      - `prompt` string, required
      - `reference_asset_ids` string[], required
      - `style_card` object, nullable, required
      - `caution_list` string[], required
    - `is_published` boolean
    - `slug` string, nullable
    - `user_prefix` string, nullable
    - `cdn_status` object[]
      - `asset_id` string, uuid, required
      - `item_name` string, nullable, required
      - `type` string, required
      - `cdn_url` string, uri, required
      - `status` string, required
      - `file_size` number, nullable, required
    - `created_at` string, required
    - `updated_at` string, required
  - `meta` Meta, required
    - `pagination` Pagination
      - `total` integer, required
      - `limit` integer, required
      - `offset` integer, required
      - `has_more` boolean, required
      - `next_cursor` string, nullable: Pass as the cursor query parameter to get the next page. Null on the last page.

## Other responses

- `400`: Validation error
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `409`: Conflict

---

[API](https://skmtc.dev/masko/apis/masko-api.md) · [All operations](https://skmtc.dev/masko/apis/masko-api/llms.txt) · [OpenAPI document](https://skmtc.dev/masko/apis/masko-api/revisions/91eb3006a92f?raw)
