---
title: "List consent receipts for a grant"
method: GET
path: "/data-sharing/receipts"
tags: ["Consent and data sharing"]
---

# List consent receipts for a grant

`GET /data-sharing/receipts`

## Request

- Base URL: `https://platform-api.homejourney.sg/v1`
- URL: `https://platform-api.homejourney.sg/v1/data-sharing/receipts`
- Auth: HTTP bearer

Returns append-only consent receipts for a grant the authenticated organization holds. Requires `consents.read` and a `grant_id` query parameter. External URL: `/v1/data-sharing/receipts`. Current Next.js implementation path: `/api/platform/v1/data-sharing/receipts`. This read-only route does not require `Idempotency-Key`; the consent text snapshot is redacted.

## Query parameters

- `grant_id` string, uuid, required

## Headers

- `X-Correlation-Id` string

## Response `200`

Consent receipts for the grant.

- PlatformConsentReceiptsResponse
  - `receipts` PlatformConsentReceiptResource[], required
    - `id` string, uuid, required
    - `environment` 'sandbox' | 'live', required
    - `grant_id` string, uuid, required
    - `receipt_status` 'issued' | 'revoked' | 'renewed' | 'superseded' | 'expired', required
    - `subject_user_id` string, uuid, required
    - `recipient_type` 'ai_host' | 'marketplace_app' | 'bank' | 'law_firm' | 'agent' | 'agency' | 'service_provider' | 'developer' | 'official_source_operator' | 'internal_operator', required
    - `recipient_display_name` string, required
    - `scope` string, required
    - `data_category` string, required
    - `purpose` string, required
    - `consent_text_version` string, required
    - `source_channel` string, required
    - `issued_at` string, date-time, required
    - `expires_at` string, date-time, nullable
    - `revoked_at` string, date-time, nullable
    - `support_contact` string, nullable
    - `retention_until` string, date-time, required
    - `created_at` string, date-time, required
  - `public_safety` PlatformConsentPublicSafety, required: Redaction guarantees applied to every consent response.
    - `consent_text_returned` false, required
    - `raw_user_pii_returned` false, required
    - `internal_audit_ids_returned` false, required
    - `recipient_billing_returned` false, 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.

---

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