---
title: "List relays addressed to a role's inbox"
method: GET
path: "/api/relay/inbox"
tags: ["Relay"]
---

# List relays addressed to a role's inbox

`GET /api/relay/inbox`

## Request

- Base URL: `http://localhost:38200`
- URL: `http://localhost:38200/api/relay/inbox`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `token`

## Query parameters

- `role` string, required
- `project_id` integer
- `include_all` 'true' | '1' | 'false' | '0'

## Response `200`

Inbox.

- object
  - `relays` Relay[]
    - `id` integer
    - `tenantId` integer
    - `projectId` integer, nullable
    - `parentId` integer, nullable
    - `kind` string: objective | milestone | goal | work_item | relay
    - `ownerRole` string, nullable
    - `status` string: draft | not_started | ready | in_progress | blocked | done | superseded
    - `origin` string, nullable: greenfield | leverage | migrate | unknown
    - `title` string
    - `contextId` integer, nullable
    - `verifyCmd` string, nullable
    - `evidence` string, nullable
    - `targetWeeks` integer, nullable
    - `startsAt` string, date-time, nullable
    - `endsAt` string, date-time, nullable
    - `size` string, nullable
    - `effortWeeks` number, nullable
    - `externalRef` object
    - `orderIndex` integer
    - `fromRole` string, nullable: Relay routing (kind='relay' only).
    - `toRole` string, nullable: Relay routing (kind='relay' only).
    - `claimedBySessionId` integer, nullable
    - `nudgeCount` integer
    - `lastNudgedAt` string, date-time, nullable
    - `nudgedBySessionId` integer, nullable
    - `payload` object
    - `doneAt` string, date-time, nullable
    - `archivedAt` string, date-time, nullable
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `syncOwned` boolean: Server-only marker set exclusively by POST /api/goal/sync.
    - `objectiveRunId` string, nullable

## Other responses

- `400`: Request body/query failed Zod validation.
- `401`: Missing or invalid credentials.

---

[API](https://skmtc.dev/contextq/apis/contextq-api.md) · [All operations](https://skmtc.dev/contextq/apis/contextq-api/llms.txt) · [OpenAPI document](https://skmtc.dev/contextq/apis/contextq-api/revisions/7afc44056a22?raw)