Skip to content

List Suggestions

GET
/users/{user_id}/suggestions
curl --request GET \
--url 'https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/suggestions?status=pending&offset=0'

The inbox — pending suggestions (newest first) + the pending count for the bell badge.

user_id
required
User Id
string format: uuid
status
Status
string
default: pending
limit
Any of:
integer
>= 1 <= 500

Max rows to return (≤500). Omit for a sane default.

offset
Offset

Rows to skip (pagination).

integer
0

Rows to skip (pagination).

Successful Response

Media typeapplication/json
SuggestionListResponse

The inbox: suggestions (newest first) + the pending count for the bell badge.

object
pending_count
required
Pending Count
integer
suggestions
required
Suggestions
Array<object>
SuggestionRead
object
confidence
required
Any of:
number
created_at
required
Created At
string format: date-time
decided_at
required
Any of:
string format: date-time
expires_at
required
Any of:
string format: date-time
id
required
Id
string format: uuid
kind
required
Kind
string
occurred_at
required
Any of:
string format: date-time
payload
required
Payload
object
key
additional properties
any
provenance
required
Provenance
object
key
additional properties
any
resulting_event_id
required
Any of:
string format: uuid
resulting_place_id
required
Any of:
string format: uuid
source
required
Source
string
status
required
Status
string
summary
required
Summary
string
title
required
Title
string
window_end
required
Any of:
string format: date-time
window_start
required
Any of:
string format: date-time
Examplegenerated
{
"pending_count": 1,
"suggestions": [
{
"confidence": 1,
"created_at": "2026-04-15T12:00:00Z",
"decided_at": "2026-04-15T12:00:00Z",
"expires_at": "2026-04-15T12:00:00Z",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"kind": "example",
"occurred_at": "2026-04-15T12:00:00Z",
"payload": {},
"provenance": {},
"resulting_event_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"resulting_place_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"source": "example",
"status": "example",
"summary": "example",
"title": "example",
"window_end": "2026-04-15T12:00:00Z",
"window_start": "2026-04-15T12:00:00Z"
}
]
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}