---
title: "Retrieve a Consent"
method: GET
path: "/v1/consents/{consentId}"
tags: ["Customers"]
---

# Retrieve a Consent

`GET /v1/consents/{consentId}`

## Request

- Base URL: `https://hyperscale0.ai`
- URL: `https://hyperscale0.ai/v1/consents/{consentId}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Retrieve a single Consent by its consentId. A record of a customer's consent, scoped to one Product, a set of providers and data categories. The record carries its status, version and expiry.

## Path parameters

- `consentId` string, required

## Query parameters

- `productId` string: Hyperscale product ID

## Headers

- `X-Hyperscale-Environment` 'sandbox' | 'live'

## Response `200`

Success

- ConsentRetrieveOutput
  - `consentId` string, required: Hyperscale customer consent ID
  - `tenantId` string, required: Organization tenant ID
  - `productId` string: Hyperscale product ID
  - `customerId` string: Tenant-local customer ID
  - `subjectId` string
  - `subjectKind` string
  - `status` 'active' | 'expired' | 'revoked'
  - `version` string
  - `expiresAt` string, date-time
  - `createdAt` string, date-time

## Other responses

- `default`: ErrorResponse. See x-error-codes and x-errors for codes, HTTP statuses and retry guidance.

---

[API](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api.md) · [All operations](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/revisions/e9e8faa044d5?raw)