---
title: "List valuation widget keys"
method: GET
path: "/valuations/embed-keys"
tags: ["Valuations"]
---

# List valuation widget keys

`GET /valuations/embed-keys`

## Request

- Base URL: `https://platform-api.homejourney.sg/v1`
- URL: `https://platform-api.homejourney.sg/v1/valuations/embed-keys`
- Auth: HTTP bearer

Lists the organization's publishable valuation widget keys for the key's environment when the authenticated client has `valuations.embed_keys.read`, newest first, with each key's registered origins and status. External URL: `/v1/valuations/embed-keys`. Current Next.js implementation path: `/api/platform/v1/valuations/embed-keys`. This read-only route does not require `Idempotency-Key`. A widget key is publishable, not a secret: it ships in the partner page and works only on the free public valuation routes, from its registered origins, with a cap of 2,000 estimates a day per key. It never authenticates this API.

## Headers

- `X-Correlation-Id` string

## Response `200`

The organization's widget keys.

- ValuationEmbedKeyListResponse
  - `embed_keys` object[], required
    - `id` string, uuid, required
    - `embed_key` string, required: The publishable key the widget script sends as `embed_key`.
    - `label` string, required
    - `allowed_origins` string[], required
    - `status` 'active' | 'revoked', required
    - `created_at` string, date-time, required
    - `revoked_at` string, date-time, nullable, required
  - `livemode` boolean, required
  - `request_id` string, required

## Other responses

- `400`: Request validation failed.
- `401`: Missing or invalid platform API key.
- `403`: Credential, environment, or scope is not allowed.
- `404`: Platform API feature or resource is not available.
- `429`: Rate limit exceeded.
- `500`: Unexpected platform API failure.
- `503`: A required managed platform dependency is unavailable.

---

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