---
title: "List all device models"
method: GET
path: "/api/models"
tags: ["Models"]
---

# List all device models

`GET /api/models`

## Request

- Base URL: `https://trmnl.com`
- URL: `https://trmnl.com/api/models`
- Auth: none declared

## Response `200`

Success

- object
  - `data` Model[]
    - `name` string: Unique identifier
    - `label` string: Human-readable name
    - `description` string: Description
    - `width` integer: Screen width in pixels
    - `height` integer: Screen height in pixels
    - `colors` integer: Number of colors supported
    - `bit_depth` integer: Color bit depth
    - `scale_factor` number: Display scale factor
    - `rotation` integer: Screen rotation in degrees
    - `mime_type` string: Image MIME type
    - `offset_x` integer: X offset for image rendering
    - `offset_y` integer: Y offset for image rendering
    - `kind` 'trmnl' | 'kindle' | 'byod' | 'tidbyt' | 'vestaboard': Device kind (e.g., trmnl, kindle, byod)
    - `palette_ids` string[]: Supported color palette IDs
    - `preview_white_point` 'true_white' | 'limited': Preview white point mode for color previews
    - `image_size_limit` integer, nullable: Maximum image file size in bytes for webhook uploads; null means the model declares no limit
    - `image_upload_supported` boolean: Whether webhook image uploads are supported for this device type
    - `css` object, nullable: CSS classes and variables for web rendering
      - `classes` object
        - `device` string
        - `size` string
        - `density` string
      - `variables` array[]
        - string[]

---

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