---
title: "List sandbox official-source freshness labels"
method: GET
path: "/official-sources/freshness"
tags: ["Official sources"]
---

# List sandbox official-source freshness labels

`GET /official-sources/freshness`

## Request

- Base URL: `https://platform-api.homejourney.sg/v1`
- URL: `https://platform-api.homejourney.sg/v1/official-sources/freshness`
- Auth: HTTP bearer

Returns source-attributed sandbox freshness labels when the authenticated automation client has `official_sources.freshness.read`. External URL: `/v1/official-sources/freshness`. Current Next.js implementation path: `/api/platform/v1/official-sources/freshness`. Freshness reads are read-only and do not trigger upstream refreshes; live upstream freshness reads remain deferred.

## Query parameters

- `source_id` string
- `dataset_id` string

## Headers

- `X-Correlation-Id` string

## Response `200`

Sandbox official-source response.

- OfficialSourceFreshnessResponse
  - `freshness` object[], required
    - `dataset_id` string, required
    - `source_id` string, required
    - `dataset_name` string, required
    - `freshness_status` 'fresh' | 'aging' | 'stale' | 'outage_fallback' | 'manual_review' | 'disputed' | 'terms_blocked' | 'unknown', required
    - `retrieved_at` string, date-time, required
    - `valid_from` string, date-time, nullable, required
    - `valid_to` string, date-time, nullable, required
    - `license_label` string, required
    - `degraded_reason` string, nullable, required
    - `attribution` object, required
      - `source_agency` string, required
      - `source_name` string, required
      - `source_url_or_id` string, required
      - `retrieved_at` string, date-time, required
      - `valid_from` string, date-time, nullable, required
      - `valid_to` string, date-time, nullable, required
      - `license_label` string, required
      - `freshness_status` 'fresh' | 'aging' | 'stale' | 'outage_fallback' | 'manual_review' | 'disputed' | 'terms_blocked' | 'unknown', required
      - `confidence` number, required
      - `schema_version` string, required
      - `derived_from` string[], required
  - `access` object, required
    - `organization_id` string, uuid, required
    - `client_id` string, uuid, required
    - `granted_official_source_scopes` PlatformScope[], required
    - `actor_model` 'api_key_automation_client', required
    - `live_upstream_access` 'deferred', required
    - `sandbox_fixture_mode` 'read_only', required
    - `upstream_credential_material_returned` false, required
  - `livemode` false, 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.

---

[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)