---
title: "Get Payday Status"
method: GET
path: "/api/payday/status"
tags: ["Payday"]
deprecated: true
---

# Get Payday Status

`GET /api/payday/status`

## 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/status`
- Auth: HTTP bearer

> **Deprecated.**

Get detected payday info, days until next payday, and last payday date.

## Response `200`

Successful Response

- PaydayStatusResponse
  - `detected_payday` integer, required
  - `next_payday` string, required
  - `days_until_payday` integer, required
  - `last_payday` string, nullable, required
  - `monthly_income` number, required
  - `is_payday_today` boolean, required
  - `pay_confirmed` boolean
  - `pay_cadence` string, nullable
  - `pay_amount` number, nullable
  - `next_payday_known` boolean
  - `cycle_start` string, nullable
  - `cycle_end` string, nullable

---

[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)