Skip to content

The caller's inbox (REQ-091).

GET
/inbox
curl --request GET \
--url https://example.com/api/v1/inbox

The inbox.

Media typeapplication/json
object
seen_at
required
string format: date-time
items
required
Array<object>
object
kind
required
string
Allowed values: review_request waiver_request waiver_rejected waiver_ended message mention run
bundle_id
required
string format: uuid
doc_id
required

The spec doc the item is about.

string format: uuid
bundle_title
required
string
thread_id
string format: uuid
waiver_id

The waiver an item is about. The bundle page opens on the finding it excuses, or on the verification run a verification waiver came from.

string format: uuid
text
required
string
at
required
string format: date-time
unread
required
boolean
key
required

Names the item, so a click marks this one item read.

string
Example
{
"items": [
{
"kind": "review_request"
}
]
}

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"code": "example"
}