# Get the weekly summary settings

`GET https://evohub.io/api/v1/uptime-digest`

Part of the [Uptime API](https://docs-dev.evohub.io/uptime.md) reference · operationId `getWeeklySummarySettings`.

Whether the organization's weekly uptime summary email is on, and
whether the caller receives it.

Requires the `uptime:monitor:read` scope.

## Authorization

Any one of:

- `bearerKey`
- `headerKey`

Where:

- `bearerKey`: HTTP Bearer — An EvoHub API key (`evohub_…`) as a bearer token.
- `headerKey`: API key in the header `X-API-Key` — An EvoHub API key (`evohub_…`).

## Responses

### 200 — The weekly summary settings, as the caller sees them.

Content type: `application/json`

Type: `object`

- `data` (DigestSettings)
  - `available` (boolean, required): Whether EvoHub sends the weekly summary at all. When `false`, nothing is sent whatever the other fields say.
  - `enabled` (boolean, required): Whether the organization has it on.
  - `subscribed` (boolean, required): Whether the caller receives it, if they are an owner or administrator.
  - `can_manage` (boolean, required): Whether the caller may turn it on or off and send a preview. Always `false` for an API key.

### 401 — No API key was sent, or it is unknown, revoked or expired (`UNAUTHORIZED`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `MONITOR_NOT_FOUND`)
  - `message` (string, required, example `monitor not found`)
  - `request_id` (string)

### 403 — The key lacks the scope this endpoint needs (`FORBIDDEN`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `MONITOR_NOT_FOUND`)
  - `message` (string, required, example `monitor not found`)
  - `request_id` (string)

### 429 — Too many requests (`RATE_LIMITED`). Wait for `Retry-After` seconds.

Headers:

- `Retry-After` (integer): Seconds to wait before retrying.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `MONITOR_NOT_FOUND`)
  - `message` (string, required, example `monitor not found`)
  - `request_id` (string)

### 500 — Something went wrong on EvoHub's side (`INTERNAL_ERROR`). Retry later.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required, example `MONITOR_NOT_FOUND`)
  - `message` (string, required, example `monitor not found`)
  - `request_id` (string)

## Example request

```bash
curl -X GET 'https://evohub.io/api/v1/uptime-digest' \
  -H 'Authorization: Bearer <TOKEN>'
```