---
title: "List Consents"
method: GET
path: "/v1/consents"
tags: ["Customers"]
---

# List Consents

`GET /v1/consents`

## Request

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

List Consents as a cursor-paginated page. 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.

## Query parameters

- `productId` string: Hyperscale product ID
- `limit` integer: Maximum items to return (1-100). Defaults to 50 when omitted.
- `cursor` string
- `query` string
- `createdFrom` string, date-time
- `createdTo` string, date-time
- `customerId` string: Tenant-local customer ID
- `status` 'active' | 'expired' | 'revoked'

## Headers

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

## Response `200`

Success

- ConsentListOutput
  - `items` object[], required
    - `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
  - `nextCursor` string
  - `statusCounts` object

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