Consent and data sharing

List recipient-scoped data-sharing grants

Returns the data-sharing grants where the authenticated platform organization is the recipient. Requires consents.read. External URL: /v1/consents. Current Next.js implementation path: /api/platform/v1/consents. This read-only route does not require Idempotency-Key; consent text, raw user PII, and internal audit ids are never returned.

get/consents

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/consents
  • Auth: HTTP bearer

Query parameters

data_categorystring

Optional data-category filter.

include_inactive'true' | 'false'

Include revoked/expired/superseded grants when true.

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Response

Recipient-scoped grants.

livemodeboolean required
request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.