---
title: "List consent records for account's subscribers"
method: GET
path: "/v1/compliance/consents"
tags: ["Compliance / CASL"]
---

# List consent records for account's subscribers

`GET /v1/compliance/consents`

## Request

- Base URL: `https://api.honkio.ca`
- URL: `https://api.honkio.ca/v1/compliance/consents`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Requires `compliance:r`.

## Query parameters

- `phone_number` string
- `email_address` string
- `status` 'ACTIVE' | 'EXPIRED' | 'REVOKED'
- `consent_batch_id` string
- `page` integer
- `limit` integer

## Response `200`

A page of consent records, newest first. No total is returned.

- object: A page of consent records, newest first. No total is returned.
  - `data` Consent[], required
    - `id` string, required
    - `accountId` string, required
    - `channel` 'SMS' | 'EMAIL', required
    - `phoneNumber` string, nullable, required
    - `emailAddress` string, nullable, required
    - `consentType` 'EXPRESS' | 'IMPLIED', required
    - `status` 'ACTIVE' | 'EXPIRED' | 'REVOKED', required
    - `sourceDescription` string, nullable, required
    - `sourceIp` string, nullable, required
    - `sourceUrl` string, nullable, required
    - `relationshipType` string, nullable, required
    - `expiresAt` string, date-time, nullable, required
    - `grantedAt` string, date-time, required
    - `revokedAt` string, date-time, nullable, required
    - `revokedReason` string, nullable, required
    - `doubleOptInConfirmedAt` string, date-time, nullable, required: When the subscriber last confirmed double opt-in by replying YES to an opt-in confirmation from one of your toll-free numbers. A toll-free send needs a confirmation from its own sending number: see GET /v1/compliance/opt-in-confirmations.
    - `doubleOptInConfirmationId` string, nullable, required: The opt-in confirmation (oic_…) they answered.
    - `consentBatchId` string, nullable, required: The bulk upload (cb_…) that recorded this consent; null for one recorded on its own.

## Other responses

- `401`: Missing, invalid, revoked or expired API key.
- `402`: The account has no balance, or a LIVE key was used before the first top-up.
- `403`: The API key lacks the permission this operation requires, or the account is suspended or closed.
- `422`: VALIDATION_ERROR: the request failed validation; details names the fields.
- `429`: Rate limit reached: 100 requests per second per account, or a route-specific limit (Retry-After set where one applies).
- `500`: Unexpected server error.
- `501`: EMAIL_COMING_SOON: email consent is available when the email product launches (sent only for an email_address request).

---

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