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

# List sandbox official-source registry entries

`GET /official-sources`

## Request

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

Returns source registry entries for the sandbox official-source fixture surface when the authenticated automation client has `official_sources.read`. External URL: `/v1/official-sources`. Current Next.js implementation path: `/api/platform/v1/official-sources`. This read-only route does not require `Idempotency-Key`; SDK, CLI, and MCP read adapters may call this sandbox route while live upstream agency reads, real credential lookups, and source refresh jobs remain deferred.

## Headers

- `X-Correlation-Id` string

## Response `200`

Sandbox official-source response.

- OfficialSourceListResponse
  - `sources` object[], required
    - `source_id` string, required
    - `source_agency` string, required
    - `source_name` string, required
    - `source_category` string, required
    - `source_url_or_id` string, required
    - `license_label` string, nullable, required
    - `terms_review_status` string, required
    - `freshness_owner_present` boolean, required
    - `rollback_or_fallback_present` boolean, required
    - `sandbox_fixture_available` boolean, required
    - `public_display_allowed` boolean, required
    - `partner_access_allowed` boolean, required
    - `partner_facing_ready` boolean, required
    - `missing_requirements` string[], required
    - `credential_class` 'none' | 'public_key' | 'protected_token' | 'paid_credential' | 'manual_only', 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)