---
title: "List recorded consent for marketing calls"
method: GET
path: "/call-consents"
tags: ["Calls"]
---

# List recorded consent for marketing calls

`GET /call-consents`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/call-consents`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.hypamoon.com/oauth/authorize`, token URL `https://api.hypamoon.com/oauth/token`, scopes: `calls:read`)

The project's recorded consents for marketing calls, newest first, active and revoked. With phone_number only those for that number. The number itself is never stored, only a keyed hash plus its last two digits (phone_number_ending).

## Query parameters

- `phone_number` string

## Response `200`

The consents.

- CallConsentList: The project's recorded consents.
  - `data` CallConsent[], required: The consents, newest first (at most 100).
    - `id` string, uuid, required: The id of the consent.
    - `phone_number_ending` string, required: The last two digits of the number. The number itself is never stored, only a keyed hash.
    - `source` 'form' | 'call' | 'import' | 'manual', required: Where the consent came from: form, call, import or manual.
    - `evidence` string, required: Your reference to the proof.
    - `consented_at` string, date-time, required: When the person gave consent.
    - `recorded_at` string, date-time, required: When it was recorded here.
    - `revoked_at` string, date-time, nullable, required: When it was revoked; null while it is valid.
    - `status` 'active' | 'revoked', required: active: marketing calls to this number are allowed. revoked: no longer.

## Other responses

- `400`: Bad Request: invalid_parameter.
- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

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