---
title: "Read email preferences"
method: GET
path: "/v1/email-preferences"
tags: ["Account"]
---

# Read email preferences

`GET /v1/email-preferences`

## Request

- Base URL: `https://api.postlake.dev`
- URL: `https://api.postlake.dev/v1/email-preferences`
- Auth: `bearerAuth` (a scheme the document does not define)

How often this account receives the attention summary: the one email PostLake sends on its own schedule, when a channel has stopped working or a scheduled post did not go out. Account and security email (verify, password reset, new sign-in, payment failed) always sends and is not covered here.

## Response `200`

Current preferences

- EmailPreferences
  - `digest` boolean, required: False when digestFrequency is off. Kept so older clients still work.
  - `digestFrequency` 'off' | 'weekly' | 'daily', required
  - `onboarding` boolean, required: Whether optional product emails may send.

## Other responses

- `401`: Unauthorized

---

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