---
title: "Get a brief's read status"
method: GET
path: "/briefs/{id}/read-status"
tags: ["Briefs"]
---

# Get a brief's read status

`GET /briefs/{id}/read-status`

## Request

- Base URL: `https://viral.app/api/v1`
- URL: `https://viral.app/api/v1/briefs/{id}/read-status`
- Auth: API key in header `x-api-key`

Lists the creators who read a brief: per creator the routes it reaches them through (campaign, sent directly, everyone), whether they read the current version, an earlier one, or not yet, and when they were last notified. Counts cover the whole audience; creators who have not joined the organization yet are only counted.

## Path parameters

- `id` string, required: Campaign brief ID with orgbrief_ prefix

## Query parameters

- `search` string: Search by creator name or email
- `filter` 'all' | 'unread': unread keeps the creators who have not read the current version (earlier readers included)
- `page` number: Page number (1-based index)
- `perPage` integer: Number of creators per page (1-500)

## Response `200`

OK

- object
  - `version` integer, required
  - `counts` object, required
    - `read` integer, required
    - `readEarlier` integer, required
    - `unread` integer, required
    - `notJoined` integer, required
  - `creators` object[], required
    - `orgCreatorId` string, required: Organization creator ID with orgcre_ prefix
    - `userId` string, required: User ID with user_ prefix
    - `name` string, nullable, required
    - `email` string, nullable, required
    - `firstName` string, nullable, required
    - `image` string, nullable, required
    - `routes` union[], required
      - union
        - object
          - `kind` 'campaign', required
          - `campaignId` string, required: Campaign ID with orgcamp_ prefix
          - `campaignName` string, required
        - object
          - `kind` 'direct', required
        - object
          - `kind` 'everyone', required
    - `state` 'read' | 'read_earlier' | 'unread' | 'not_joined', required
    - `readVersion` integer, nullable, required
    - `readAt` string, date-time, nullable, required
    - `notifiedAt` string, date-time, nullable, required
  - `pageCount` number, required: Total number of pages
  - `totalRows` number, required: Total number of rows

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `404`: 404
- `408`: 408
- `429`: 429
- `500`: 500

---

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