---
title: "Get Mail Box"
method: GET
path: "/mailbox/{mailbox_uid}"
---

# Get Mail Box

`GET /mailbox/{mailbox_uid}`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/mailbox/{mailbox_uid}`
- Auth: API key in header `x-api-key`

Get Mail Box details.

## Path parameters

- `mailbox_uid` string, required

## Response `200`

- object
  - `type` string
  - `data` object
    - `mailbox_uid` string
    - `email` string
    - `provider` string
    - `mailbox_type` 'PERSONAL' | 'SHARED'
    - `shared_users` object[]
      - `user_uid` string
      - `first_name` string
      - `last_name` string
      - `email` string
      - `external_login_id` string
      - `home_phone_number` string, nullable
      - `designation` string
      - `emp_code` string
      - `prefix` string, nullable
      - `work_phone_number` string, nullable
      - `mobile_phone_number` string, nullable
      - `profile_picture` string
      - `hourly_labor_charge` number
      - `is_active` boolean
      - `is_deleted` boolean
      - `created_at` string
      - `updated_at` string
      - `last_login_at` string, nullable
      - `role` object
        - `role_id` integer
        - `role_uid` string
        - `role_name` string
        - `role_key` string
        - `created_at` string
        - `updated_at` string
      - `user_meta_data` unknown

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/mailbox/:mailbox_uid/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)
