---
title: "Get Payday Preview"
method: GET
path: "/api/payday/preview/{user_id}"
tags: ["Payday"]
deprecated: true
---

# Get Payday Preview

`GET /api/payday/preview/{user_id}`

## Request

- Base URL: `https://api.earmarkiq.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.earmarkiq.app/api/payday/preview/{user_id}`
- Auth: HTTP bearer

> **Deprecated.**

Get a payday preview with detected payday date, timeline,
and smart suggestions based on the user's spending analysis.

## Path parameters

- `user_id` string, uuid, required

## Response `200`

Successful Response

- PaydayPreview
  - `detected_payday` integer, required
  - `next_payday` string, required
  - `days_until_payday` integer, required
  - `monthly_income` number, nullable, required
  - `total_allocated` number, required
  - `remaining_after_rules` number, required
  - `timeline` TimelineEvent[], required
    - `order` integer, required
    - `day` integer, required
    - `label` string, required
    - `amount` number, required
    - `type` string, required
    - `icon` string, required
    - `color_key` string, required
  - `rules` PaydayRule[], required
    - `id` string, required
    - `type` string, required
    - `amount` number, required
    - `timing` string, required
    - `timing_label` string, required
    - `active` boolean, required
    - `description` string, nullable
    - `target_id` string, nullable
    - `target_label` string, nullable
    - `virtual_budget_category` string, nullable
    - `pot_category` string, nullable
    - `goal_id` string, nullable
    - `goal_name` string, nullable
  - `suggestions` SmartSuggestion[], required
    - `type` string, required
    - `title` string, required
    - `description` string, required
    - `amount` number, required
    - `timing` string, required
    - `timing_label` string, required
    - `icon` string, required
    - `color_key` string, required
  - `has_data` boolean, required
  - `salary_detection_status` string
  - `income_stale` boolean
  - `one_off_income_this_cycle` number
  - `incoming_this_cycle` number

## Other responses

- `422`: Validation Error

---

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