---
title: "List inbox embeds"
method: GET
path: "/inbox_embeds"
tags: ["Inbox Embeds"]
---

# List inbox embeds

`GET /inbox_embeds`

Returns inbox embed access links for your project, most recent first. Raw tokens and embed URLs are not returned after creation.

## Query parameters

- `status` 'active' | 'revoked'
- `scope_type` 'project' | 'customer' | 'phone_number'
- `scope_id` string
- `assigned_user_id` string, uuid
- `page` integer
- `per_page` integer

## Response `200`

Success

- InboxEmbedListResponse
  - `data` InboxEmbed[], required
    - `id` string, uuid, required
    - `name` string, nullable
    - `scope_type` 'project' | 'customer' | 'phone_number', required — Public embed scope
    - `scope_id` string, nullable — Customer UUID for `customer`, WhatsApp `phone_number_id` for `phone_number`, null for `project`
    - `scope_name` string, nullable — Human-readable customer or phone number label when available
    - `assigned_user_id` string, uuid, nullable — Limits visible conversations to the active assignee
    - `assigned_user_name` string, nullable
    - `status` 'active' | 'revoked', required
    - `allowed_origins` string[], required — Origins allowed to embed the inbox. Empty means any origin.
    - `default_mode` 'system' | 'light' | 'dark', required
    - `language` 'en' | 'es', required — UI language for the embedded inbox.
    - `expires_at` string, date-time, nullable
    - `last_used_at` string, date-time, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `meta` PaginationMeta, required
    - `page` integer, required
    - `per_page` integer, required
    - `total_pages` integer, required
    - `total_count` integer, required

## Other responses

- `401` — Missing or invalid API key
- `422` — Request validation failed

---

[API](https://skmtc.net/kapso/apis/kapso-platform-api.md) · [All operations](https://skmtc.net/kapso/apis/kapso-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kapso/kapso-platform-api/revisions/18ff5548a33f/schema)