---
title: "Get the auto-reply"
method: GET
path: "/mailboxes/{address}/auto-reply"
tags: ["Mailboxes"]
---

# Get the auto-reply

`GET /mailboxes/{address}/auto-reply`

## Request

- Base URL: `https://faivelo.com/api/v1`
- URL: `https://faivelo.com/api/v1/mailboxes/{address}/auto-reply`
- Auth: HTTP bearer

The mailbox's automatic reply (out of office), as the mail server holds it. Requires scope `mail:read`.

## Path parameters

- `address` string, required

## Response `200`

The auto-reply

- object
  - `success` boolean
  - `data` AutoReply
    - `enabled` boolean
    - `subject` string, nullable
    - `textBody` string, nullable
    - `htmlBody` string, nullable
    - `fromDate` string, date-time, nullable: Replies start here; null means as soon as it is on
    - `toDate` string, date-time, nullable: Replies stop here; null means until switched off

## Other responses

- `401`: Missing or invalid API key
- `402`: The account's plan does not include the API (`plan_required`)
- `403`: The key lacks the required scope
- `404`: Resource not found
- `429`: Rate limit exceeded

---

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