---
title: "List digest entries"
method: GET
path: "/digest"
tags: ["Digest"]
---

# List digest entries

`GET /digest`

## Request

- Base URL: `https://service.steady.space/api/v2`
- URL: `https://service.steady.space/api/v2/digest`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://app.steady.space/oauth/authorize`, token URL `https://app.steady.space/oauth/token`)
  - HTTP bearer

## Query parameters

- `category` 'check-in' | 'comment' | 'echo' | 'goal'
- `unread` true
- `since` string, date-time
- `page` integer
- `per_page` integer

## Response `200`

A page of digest entries.

- DigestEntry[]
  - `id` string, uuid, required
  - `category` 'check-in' | 'comment' | 'echo' | 'goal', required
  - `published_at` string, date-time, required
  - `read_at` string, date-time, nullable, required: When the user read the entry through the web app. `null` if the entry has not been read.
  - `resource` union, required
    - CheckIn
      - `type` 'check-in'
      - `id` string, uuid, required
      - `date` string, date, required
      - `person` PersonRef, required
        - `id` string, uuid, required
        - `name` string, required
      - `teams` TeamRef[], required
        - `id` string, uuid, required
        - `name` string, required
      - `team_ids` Id[]: IDs of teams to include in this check-in. Defaults to all the person's teams if omitted.
      - `previous` string, nullable: Answer to "What did you do previously?" rendered as Markdown.
      - `intentions` string, nullable: Answer to "What do you intend to do next?" rendered as Markdown.
      - `blockers` string, nullable: Answer to "Are you blocked by anything?" rendered as Markdown.
      - `mood` 'calm' | 'happy' | 'excited' | 'celebratory' | 'joyful' | 'confident' | 'focused' | 'goofy' | 'nerdy' | 'thoughtful' | 'meh' | 'confused' | 'flustered' | 'surprised' | 'tired' | 'disappointed' | 'worried' | 'annoyed' | 'stressed' | 'angry' | 'sick', nullable
      - `previous_completed` boolean, nullable: Answer to "Did you do what you intended?".
      - `blocked` boolean, required: Whether the check-in contains blockers.
      - `absent` boolean, required
      - `completed_at` string, date-time, nullable, required
      - `updated_at` string, date-time, required
      - `url` string, uri, required
    - Comment
      - `type` 'comment'
      - `id` string, uuid, required
      - `body` string, required: Comment body rendered as Markdown.
      - `person` PersonRef, required
        - `id` string, uuid, required
        - `name` string, required
      - `resource` ResourceRef, required: Reference to a related resource by `type` and `id`.
        - `type` 'check-in' | 'goal-update', required
        - `id` string, uuid, required
      - `created_at` string, date-time, required
    - EchoAnswer
      - `type` 'echo-answer'
      - `id` string, uuid, required
      - `question` EchoQuestionRef, required
        - `id` string, uuid, required
        - `title` string, required
      - `title` string, required
      - `body` string, nullable, required: Answer rendered as Markdown. `null` while the AI-generated content summary is still being produced.
      - `published_at` string, date-time, required
      - `url` string, uri, required
    - Goal
      - `type` 'goal'
      - `id` string, uuid, required
      - `title` string
      - `description` string: Goal description rendered as Markdown.
      - `start_date` string, date
      - `end_date` string, date
      - `update_cadence` 'Weekly' | 'Biweekly' | 'Monthly'
      - `owner` PersonRef, required
        - `id` string, uuid, required
        - `name` string, required
      - `owner_id` string, uuid
      - `parent` GoalRef, required
        - `id` string, uuid, required
        - `title` string, required
      - `parent_id` string, uuid
      - `private` boolean
      - `archived` boolean
      - `progress` integer, required: Progress percentage toward completing the goal.
      - `confidence` integer, required: Confidence score, normalized to one of: 30 (Off track), 60 (At risk), or 90 (On track). Returns 100 (On track) if no updates have been reported yet.
      - `confidence_description` 'Off track' | 'At risk' | 'On track', required: Human-readable label for the confidence score.
      - `contributors` PersonRef[], required
        - `id` string, uuid, required
        - `name` string, required
      - `contributor_ids` Id[]
      - `teams` TeamRef[], required
        - `id` string, uuid, required
        - `name` string, required
      - `team_ids` Id[]
      - `url` string, uri, required
    - GoalUpdate
      - `type` 'goal-update'
      - `id` string, uuid, required
      - `goal` GoalRef, required
        - `id` string, uuid, required
        - `title` string, required
      - `person` PersonRef, required
        - `id` string, uuid, required
        - `name` string, required
      - `title` string
      - `body` string: Update body rendered as Markdown.
      - `progress` integer: Progress percentage toward completing the goal.
      - `confidence` integer: Confidence score, normalized to one of: 30 (Off track), 60 (At risk), or 90 (On track). Returns 100 (On track) if no updates have been reported yet.
      - `confidence_description` 'Off track' | 'At risk' | 'On track', required: Human-readable label for the confidence score.
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `url` string, uri, required

## Other responses

- `<<`

---

[API](https://skmtc.dev/statushero/apis/steady-v2-rest-api.md) · [All operations](https://skmtc.dev/statushero/apis/steady-v2-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/statushero/apis/steady-v2-rest-api/revisions/a3ee255356cd?raw)