Inbox State
Manage per-user inbox item state — dismiss, snooze, and mark-done flags for swarm notifications and approval items
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
userId*string
status?string
Value in
"open" | "snoozed" | "dismissed" | "done"itemType?string
Value in
"approval" | "credential_missing" | "broken_task" | "to_read" | "to_start_template"Response Body
application/json
application/json
application/json
curl -X GET "http://localhost:3013/api/inbox-state?userId=string"{
"items": [
{
"id": "string",
"userId": "string",
"itemType": "approval",
"itemId": "string",
"status": "open",
"snoozeUntil": "string",
"dismissedAt": "string",
"doneAt": "string",
"createdAt": "string",
"lastUpdatedAt": "string"
}
]
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "http://localhost:3013/api/inbox-state" \ -H "Content-Type: application/json" \ -d '{ "userId": "string", "itemType": "approval", "itemId": "string", "status": "open" }'{
"item": {
"id": "string",
"userId": "string",
"itemType": "approval",
"itemId": "string",
"status": "open",
"snoozeUntil": "string",
"dismissedAt": "string",
"doneAt": "string",
"createdAt": "string",
"lastUpdatedAt": "string"
}
}{
"error": "string",
"property1": null,
"property2": null
}{
"error": "string",
"property1": null,
"property2": null
}