Skip to main content
GET
List inbox items

Authorizations

klef.session
string
cookie
required

Cookie-based session. Obtain by completing the /auth/login/{provider} OAuth flow; the /auth/callback response sets the klef.session cookie that subsequent requests send automatically.

Query Parameters

kind
enum<string>[]

Filter to items of any of these kinds.

The category of an inbox item.

Available options:
sync_error,
needs_review,
setup_source,
setup_target,
setup_policy,
sync_plan_ready,
sync_plan_applied,
sync_plan_failed
from
string

Only items occurring at or after this instant.

to
string

Only items occurring at or before this instant.

q
string

Case-insensitive match on the item's title or body.

Required string length: 3 - 100
cursor
integer<int32>
limit
integer<int32>

Response

OK

The envelope for a collection response: IReadOnlyList<T> ApiCollectionResponse<T>.Results.

results
object[]
required
errors
object[]
required
pagination
null | object
required

Cursor-pagination metadata shared across every paged read. int? PageInfo.NextCursor is the offset of the next page, null on the last page.