DevelopersHow to connect an assistantKeys
Reference/Reminders/Read

Get a cardless reminder

GEThttps://api.getwerk.ai/api/v1/reminders/{reminderId}

One of the key's person's reminders that are on no card.

A reminder on a card is read under its card instead.

Authorization

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Headers

Werk-Localestring

The language tag Werk writes the answer's own words in, such as step names and history lines, matched to a language it serves; a card's text stays as written. At a project's paths, the reads of its cards and steps, of a card, its update photos, a file and its reminders, and of follow and reminder invitations, and a document's read-now and consent, take the language of the person's chat with Werk in that project first, while it has one. Without either, the language Werk uses with the person the key or the connection acts for.

Path parameters

reminderIdstring, uuidRequired

The reminder's id.

Response

200 The reminder.

idstring, uuid

The reminder's id.

itemIdnull

Always null: this reminder has no card.

versioninteger

The reminder's version, which grows with every change to it; a change sends it as expectedVersion.

At least 1
timeRevisioninteger

Grows each time the reminder's time changes; a change sends it as expectedTimeRevision.

At least 1
snoozeRevisioninteger

Grows each time the key's person snoozes the reminder; a change sends it as expectedSnoozeRevision.

At least 0
fireAtstring, date-time or null

The time its owner set the reminder for.

effectiveFireAtstring, date-time or null

When the reminder goes off for the key's person: the snoozed time, else the set time.

snoozedUntilstring, date-time or null

The time the key's person snoozed the reminder to, or null.

setterTimeZonestring

The time zone the reminder's time was set in.

textstring or null

The reminder's text, as its owner wrote it.

languagestring

The language a shared reminder's text is written in.

From 2 to 64 characters
translationobject

A shared reminder's text in the reader's language, when it is written in another.

Show properties of translationHide properties of translation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

stateenum

upcoming before it goes off, past once it went off, dropped when it will not go off, its card done, archived or out of reach.

Allowed valuesupcomingpastdropped
audienceobject

Whose reminder it is and who it is shared with.

Show properties of audienceHide properties of audience
kindenum

Always only_you: a reminder with no card is never shared.

Allowed valuesonly_you
labelstring

Who the reminder is for, in one line in the reader's language.

ownerobject

The person who set the reminder.

Show properties of ownerHide properties of owner
userIdstring, uuid

The person's id.

displayNamestring

The person's name as the project shows it.

initialsstring

The person's initials, for an avatar with no photo.

isViewerboolean

True when the person is the key's own person.

photoobject

The person's photo, when they have one.

Show properties of photoHide properties of photo
personIdstring, uuid

The person whose photo it is.

versioninteger

The photo's version, which changes with the photo; its read takes it to fetch the current one.

At least 1
invitedarray of objects

Always empty: a reminder with no card is never shared.

Exactly 0 items
Show properties of invitedHide properties of invited
userIdstring, uuid

The person's id.

displayNamestring

The person's name as the project shows it.

initialsstring

The person's initials, for an avatar with no photo.

isViewerboolean

True when the person is the key's own person.

photoobject

The person's photo, when they have one.

Show properties of photoHide properties of photo
personIdstring, uuid

The person whose photo it is.

versioninteger

The photo's version, which changes with the photo; its read takes it to fetch the current one.

At least 1
quotedReminderRefnull

Always null for a reminder with no card.

actionsarray of enums

What the key's person may do with the reminder now.

Allowed valuesdelete

Errors

400invalid_queryThe query is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
400invalid_messageThe message or reminder request is not in the form its route takes, or names a card its reminder is not on; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
404personal_reminder_not_foundThe reminder the request names is not one the signed-in person can reach.
409session_changedThe session changed while the request was in flight.
rate_limitedMore requests of this kind were sent than Werk takes within the time it counts them over.
500server_errorThe server could not complete the request, and it is not known whether a write it holds was made.
curl
curl "https://api.getwerk.ai/api/v1/reminders/4d8a1e63-9b2c-4f57-8e0d-2c6b5a9f3e17" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/reminders/4d8a1e63-9b2c-4f57-8e0d-2c6b5a9f3e17", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "id": "4d8a1e63-9b2c-4f57-8e0d-2c6b5a9f3e17",
  "itemId": null,
  "version": 1,
  "timeRevision": 1,
  "snoozeRevision": 0,
  "fireAt": "2026-11-28T14:00:00.000Z",
  "effectiveFireAt": "2026-11-28T14:00:00.000Z",
  "snoozedUntil": null,
  "setterTimeZone": "America/New_York",
  "text": "Renew the van insurance",
  "state": "upcoming",
  "audience": {
    "kind": "only_you",
    "label": "Only you",
    "owner": {
      "userId": "5d1f3a2e-8c4b-4e7a-9f21-3b6c8d0e1a42",
      "displayName": "Maya Chen",
      "initials": "MC",
      "isViewer": true
    },
    "invited": []
  },
  "quotedReminderRef": null,
  "actions": [
    "delete"
  ]
}