API reference / Tasks and projects
Get a reminder of a task
Your bell tells you of the task at the time that you give, and an email goes too if you turned it on (Reminder in Settings > Notifications). You have one reminder for each task: a new time takes the place of the old one. Give a time in the next year.
post
/api/v1/tasks/{key}/reminderOther ways to call it
CLI
troopy tasks remindMCP toolNone. Call it over REST or with the CLI.
Rate limit60 calls in 60 seconds, for each key
RetriesSend an
Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Path parameters
key*stringA task's key (VIR-12), its number (12) or its id
At least 1 characters · At most 40 characters
Body
application/jsonat*stringWhen to tell you, in ISO 8601 with a time zone
date-time
Response
200 · application/jsondata*object1 properties
remindAt*string | nullErrors
400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.