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

# List widgets

`GET /{teamPid}/widgets`

## Request

- Base URL: `https://api.rightmessage.com/v1`
- URL: `https://api.rightmessage.com/v1/{teamPid}/widgets`
- Auth: HTTP bearer

Returns every widget (popup, bar, inline or other display surface) in the project's current configuration.

Requires an API token with the `read` or `write` ability. Tokens created without abilities have `*`, which grants every ability.

## Path parameters

- `teamPid` string, required

## Response `200`

- object
  - `data` WidgetResource[], required
    - `id` string, nullable, required
    - `name` string, nullable, required
    - `type` union, required
      - string
      - 'modal'
    - `is_enabled` union, required
      - string
      - boolean
    - `flow_id` string, nullable, required
    - `frequency` union, required
      - string
      - 'session'
    - `visibility` object, required
      - `conditions` string, nullable, required
      - `trigger` string, nullable, required
    - `options` string, nullable, required

## Other responses

- `401`: Missing, invalid or revoked API token.
- `404`: Not found
- `429`: Rate limit exceeded: 120 requests per minute for project endpoints, 60 per minute for token and connection endpoints. Retry after the `Retry-After` seconds.

---

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