Work

Reminders

Personal reminders scoped to the key's issuing member.

GET/reminders

List reminders

Returns a cursor-paginated list of the reminders owned by the API key's issuing member, scoped to the key's organization. A key only ever sees the reminders created by its own member, never the whole organization's. Requires scope: reminders:read.

Response 200

No fields.

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
429Rate limited
500Unexpected server error
POST/reminders

Create a reminder

Creates a reminder owned by the API key's issuing member. The status is server-controlled and always starts as inProgress; resolvedAt is server-computed. The organization and owner are taken from the key context and never from the request body. Supports the Idempotency-Key header for safe retries. Requires scope: reminders:write.

Request body

FieldTypeDescription
titlerequired
string
The reminder text. Required. Trimmed and capped at 500 characters.
remindAt
string <date-time>
ISO-8601 time the reminder should fire. Omit, send null, or send an empty string for "Save for Later". An unparseable value is silently coerced to null.nullable

Response 201

FieldTypeDescription
idrequired
string
Unique identifier for the reminder.
objectrequired
string
The object type. Always "reminder".
titlerequired
string
The reminder text. Trimmed and capped at 500 characters.
remindAt
string <date-time>
ISO-8601 time the reminder should fire. Null means "Save for Later" (no scheduled notification).nullable
statusrequired
enuminProgress | resolved
The reminder status.
resolvedAt
string <date-time>
ISO-8601 time the reminder was resolved. Null while the reminder is in progress.nullable
createdAt
string <date-time>
ISO-8601 creation timestamp.nullable
updatedAt
string <date-time>
ISO-8601 last-update timestamp.nullable

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
409Idempotency-Key reused with a different body
422Rejected by a business rule
429Rate limited
500Unexpected server error
GET/reminders/{id}

Retrieve a reminder

Returns a single reminder by id, scoped to the key's organization and its issuing member. Returns 404 if the reminder is missing, soft-deleted, belongs to another organization, or was created by another member. Requires scope: reminders:read.

Parameters

Path

idrequired
string
The id of the reminder.

Response 200

FieldTypeDescription
idrequired
string
Unique identifier for the reminder.
objectrequired
string
The object type. Always "reminder".
titlerequired
string
The reminder text. Trimmed and capped at 500 characters.
remindAt
string <date-time>
ISO-8601 time the reminder should fire. Null means "Save for Later" (no scheduled notification).nullable
statusrequired
enuminProgress | resolved
The reminder status.
resolvedAt
string <date-time>
ISO-8601 time the reminder was resolved. Null while the reminder is in progress.nullable
createdAt
string <date-time>
ISO-8601 creation timestamp.nullable
updatedAt
string <date-time>
ISO-8601 last-update timestamp.nullable

Errors

401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error
PATCH/reminders/{id}

Update a reminder

Updates a reminder. Each field is applied only when present in the body. Setting remindAt reschedules the reminder and re-arms its notification. Setting status to resolved stamps resolvedAt; setting it back to inProgress clears resolvedAt. The reminder must belong to the key's organization and be owned by the key's issuing member. Requires scope: reminders:write.

Parameters

Path

idrequired
string
The reminder identifier.

Request body

FieldTypeDescription
title
string
The reminder text. When present it must be non-empty after trimming. Capped at 500 characters.
remindAt
string <date-time>
ISO-8601 time the reminder should fire. Setting this re-arms the notification. Null or empty clears the schedule. An unparseable value is silently coerced to null.nullable
status
enuminProgress | resolved
The reminder status. Setting "resolved" stamps resolvedAt; setting "inProgress" clears it.

Response 200

FieldTypeDescription
idrequired
string
Unique identifier for the reminder.
objectrequired
string
The object type. Always "reminder".
titlerequired
string
The reminder text. Trimmed and capped at 500 characters.
remindAt
string <date-time>
ISO-8601 time the reminder should fire. Null means "Save for Later" (no scheduled notification).nullable
statusrequired
enuminProgress | resolved
The reminder status.
resolvedAt
string <date-time>
ISO-8601 time the reminder was resolved. Null while the reminder is in progress.nullable
createdAt
string <date-time>
ISO-8601 creation timestamp.nullable
updatedAt
string <date-time>
ISO-8601 last-update timestamp.nullable

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
422Rejected by a business rule
429Rate limited
500Unexpected server error
DELETE/reminders/{id}

Delete a reminder

Soft-deletes a reminder. The reminder must belong to the key's organization and be owned by the key's issuing member. Requires scope: reminders:write.

Parameters

Path

idrequired
string
The reminder identifier.

Response 200

FieldTypeDescription
idrequired
string
The identifier of the deleted reminder.
objectrequired
string
The object type. Always "reminder".
deletedrequired
boolean
Always true.

Errors

401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error