---
title: "Get voicemail box"
method: GET
path: "/v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}"
tags: ["Voicemail Box"]
---

# Get voicemail box

`GET /v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}`

## Request

- Base URL: `https://api.alianza.com`
- URL: `https://api.alianza.com/v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}`
- Auth: API key in header `X-AUTH-TOKEN`
- TypeScript: <https://skmtc.dev/alianza/apis/alianza-public-api/docs/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/get.ts> (a function with typed inputs; its response is checked against the schema)

Use to retrieve a voicemail box

## Path parameters

- `accountId` string, required
- `partitionId` string, required
- `voicemailBoxId` string, required

## Response `200`

Successful operation

- VoicemailBoxX
  - `id` string
  - `name` string: name of the box
  - `partitionId` string: partitionid of the account
  - `accountId` string: accountid of the voicemail box
  - `voicemailToEmailAddresses` string[]: email addresses to forward all voicemail messages to
  - `voicemailToEmailEnabled` boolean: enables voicemail to email
  - `voicemailKeepAfterEmail` boolean: keep or delete the voicemail after being emailed
  - `referencedBy` VoicemailReferencedByX[]: References that point at this voicemail box
    - `type` string
    - `id` string
  - `locale` string: Locale of the voicemail box
  - `totalVoicemails` integer: Total voicemails on the box
  - `totalUnreadVoicemails` integer: Total unread voicemails on the box
  - `type` 'Normal' | 'Sub' | 'Primary' | 'BUSINESS_LINE': Type of voicemail
  - `subIds` string[]: List of sub voicemail ids, this will be populated only if this voicemail box is primary
  - `parentId` string: Parent id for this voicemail box. Applicable if this voicemail box is a sub
  - `dtmfOption` string: DTMF option for this voicemail box. If this voicemail box is a sub, options are 2 through 8 otherwise option must be 1
  - `pinLockedOut` boolean: Marks whether the pin on this sub voicemailbox has been locked out
  - `messageTranscriptionEnabled` boolean: Specifies whether voicemail messages will be transcribed to text after a voicemail message is left
  - `greetings` object: Map of voicemail box greetings

## Other responses

- `400`: Invalid request
- `401`: Unauthorized
- `404`: Not found

---

[API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/7223246c352c?raw)