---
title: "List Widgets"
method: GET
path: "/widgets"
tags: ["Widgets"]
---

# List Widgets

`GET /widgets`

## Request

- Base URL: `https://developers.chatway.app/api/v1`
- URL: `https://developers.chatway.app/api/v1/widgets`
- Auth: API key in header `X-API-KEY`

List your chat widgets, including each widget's ID, name and icon. Use data[].id as widgetId for Initialize Chat Contact, or as widget_id for Create Visitor Message. This read-only endpoint is also a useful first request for checking authentication.

## Query parameters

- `limit` integer, nullable
- `page` integer, nullable

## Response `200`

Paginated list responses include `data`, `meta.pagination`, and `links`. Use the `page` and `limit` query parameters to walk results. Follow `links.next` until it is `null`, or increment `page` until `current_page >= total_pages`.

| Field | Description |
|---|---|
| `meta.pagination.total` | Total records across all pages |
| `meta.pagination.count` | Records returned on this page |
| `meta.pagination.per_page` | Page size used for this response (matches `limit`) |
| `meta.pagination.current_page` | Current page number (1-based) |
| `meta.pagination.total_pages` | Total number of pages |
| `links.next` | URL for the next page, or `null` on the last page |
| `links.first` / `links.last` | First and last page URLs |

- object
  - `data` object[], required
    - `type` string, required
    - `id` string, required
    - `attributes` object, required
      - `name` string, nullable, required
      - `icon` string, nullable, required
  - `meta` object, required
    - `pagination` object, required
      - `total` integer, required
      - `count` integer, required
      - `per_page` integer, required
      - `current_page` integer, required
      - `total_pages` integer, required
  - `links` object, required
    - `self` string, required
    - `first` string, required
    - `next` string, nullable, required
    - `last` string, required

## Other responses

- `422`: Validation error

---

[API](https://skmtc.dev/chatway/apis/chatway-developer-docs.md) · [All operations](https://skmtc.dev/chatway/apis/chatway-developer-docs/llms.txt) · [OpenAPI document](https://skmtc.dev/chatway/apis/chatway-developer-docs/revisions/ca1a1da291cc?raw)