---
title: "Voicemails report"
method: GET
path: "/voicemails"
tags: ["Voicemails"]
---

# Voicemails report

`GET /voicemails`

## Request

- Base URL: `https://api.commpeak.com/portal`
- URL: `https://api.commpeak.com/portal/voicemails`
- Auth: API key in header `Authorization`

Returns voicemails left on the account's DID numbers, newest first, as the Voicemails report in the portal: the DID number, caller ID, receive time, the email addresses the voicemail was sent to and the playback that was played. The transcription of a voicemail is returned by the show method. Without `time_range` the last 7 days are returned; a range can span at most 1 year. Results can be narrowed by DID number and caller ID (partial match). Pagination is by `page` and `per_page` (default 100, max 1000).

## Query parameters

- `time_range` string, nullable: Date range "YYYY-MM-DD - YYYY-MM-DD" (or a single date).
- `did_number` string, nullable: Filter by DID number in E.164 format.
- `cli` string, nullable: Filter by caller ID (partial match).
- `page` integer, nullable: Page number (default 1).
- `per_page` integer, nullable: Items per page (default 100, max 1000).

## Response `200`

Successful Response

- VoicemailsResponse: Envelope returned by `GET /portal/voicemails`.
  - `voicemails` VoicemailItem[], required
    - `id` integer, required: Voicemail identifier.
    - `did_number` string, nullable: DID number the voicemail was left on.
    - `cli` string, nullable: Caller ID.
    - `received_at` string, nullable: When the voicemail was received (ISO 8601).
    - `sent_to` string[], nullable: Email addresses the voicemail was sent to.
    - `voicemail_playback_id` integer, nullable: Playback played before recording.
  - `page` integer, nullable: Current page.
  - `per_page` integer, nullable: Items per page.
  - `total` integer, nullable: Total number of items.

## Other responses

- `422`: Validation Error

---

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