DevelopersHow to connect an assistantKeys
Reference/Reminders/Read

Get a card's reminder

GEThttps://api.getwerk.ai/api/v1/projects/{projectId}/cards/{cardId}/reminders/{reminderId}

One reminder on a card, with the card.

Only a reminder of that card that the key's person sees is found.

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

projectIdstring, uuidRequired

The project's id.

cardIdstring, uuidRequired

The card's id.

reminderIdstring, uuidRequired

The reminder's id.

Response

200 The reminder and its card.

reminderobject

The reminder.

Show properties of reminderHide properties of reminder
idstring, uuid

The reminder's id.

itemIdstring, uuid

The card the reminder is on.

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

only_you for the key's person's own reminder shared with nobody, invited_by_you for their own reminder shared with others, from_owner for a reminder someone shared with them.

Allowed valuesonly_youinvited_by_youfrom_owner
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

The people the owner shared the reminder with who accepted it.

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
quotedReminderRefobject or null

The reminder's id and version as Werk's apps quote it in a chat message; null on a reminder shared by someone else.

Show properties of quotedReminderRefHide properties of quotedReminderRef
idstring, uuid

The reminder's id.

expectedVersioninteger

The reminder's version as last read.

At least 1
actionsarray of enums

What the key's person may do with the reminder now: delete their own, remove a shared one from their list, snooze it, share it.

Allowed valuesdeleteremovesnooze_hoursnooze_tomorrowinvite_in_chat
itemobject

The card the reminder is on.

Show properties of itemHide properties of item
outcomeenum

completed when the card is on its project's last step, not_completed when it was archived before it, open otherwise.

Allowed valuesopencompletednot_completed
idstring, uuid

The card's id.

refstring or null

The card's number as people write it, with # before it.

titlestring

The card's title, as written.

languagestring or null

The language the card's title and description are written in.

titleTranslationobject

The title in the reader's language, when it is written in another.

Show properties of titleTranslationHide properties of titleTranslation
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.

statusobject

The step the card is on, with where that step sits in the work.

Show properties of statusHide properties of status
keystring

The id of the step the card is on.

At least 1 character
labelstring

The step's name.

At least 1 character
categoryenum

open on a new step, done on the project's last step, active on any other step.

Allowed valuesopenactivedone
bucketenum

The kind of step the card is on; a step that ends the work reads in_progress while it is not the project's last step.

Allowed valuesnewin_progresswaitingresolvedclosed
labelLanguagestring

The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.

From 2 to 64 characters
labelTranslationobject

The step's name in the reader's language, when it is written in another.

Show properties of labelTranslationHide properties of labelTranslation
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.

dueNoticeLeadenum

How long before the due date its holder and followers get the due notice; none sends no notice.

Allowed valuesnoneat_due15_minutes1_hour2_hours1_day2_days
dueSetByobject or null

Who set the due moment; present only for a due date with a time.

Show properties of dueSetByHide properties of dueSetBy
displayNamestring

That person's name.

dueobject or null

The card's due date, or null when it has none.

Show properties of dueHide properties of due

One of 2 shapes, told apart by kind:

kinddate
kindenum

date for a due day with no time, datetime for a due moment.

Allowed valuesdate
datestring, date

The due day, as YYYY-MM-DD.

kinddatetime
kindenum

date for a due day with no time, datetime for a due moment.

Allowed valuesdatetime
atstring, date-time

The due moment, as an ISO 8601 date and time with its offset.

enteredTimeZonestring or null

The time zone the due moment was given in, when known.

assigneeobject or null

The card's holder, or null when the card is free.

Show properties of assigneeHide properties of assignee
personIdstring, uuid

The holder's person id.

displayNamestring

The holder's name as the project shows it.

initialsstring

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

photoobject

The holder'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
versioninteger

The card's version, which grows with every change to it.

At least 1
numberinteger or null

The card's number in its project, unique there and never reused.

At least 1
currentStepobject or null

The card's step among its project's steps, as the project defines it.

Show properties of currentStepHide properties of currentStep
idstring

The step's id; a change of step sends it as stepId.

At least 1 character
labelstring

The step's name.

At least 1 character
bucketenum

The kind of step: new for an open step, in_progress or waiting for one in between, resolved or closed for one that ends the work.

Allowed valuesnewin_progresswaitingresolvedclosed
labelLanguagestring

The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.

From 2 to 64 characters
labelTranslationobject

The step's name in the reader's language, when it is written in another.

Show properties of labelTranslationHide properties of labelTranslation
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.

archivedboolean

True when the card is archived: it has left the working lists and stays readable and searchable.

countsobject

How much the card holds.

Show properties of countsHide properties of counts
photosinteger

Photos on the card.

At least 0
updatesinteger

Updates on the card.

At least 0
documentsinteger

Documents on the card.

At least 0
checklistobject

The card's list: its items checked and in all; absent when the card has no list.

Show properties of checklistHide properties of checklist
doneinteger

List items checked.

At least 0
totalinteger

List items in all.

At least 0
allowedActionsarray of enums

The changes the key's person may make to this card by hand now, by action name.

Allowed valuestake_cardassign_cardgive_back_cardmove_cardarchive_cardunarchive_cardedit_cardset_card_dueadd_updatecreate_reminderlink_duplicateadd_entriesrename_entryremove_entryreorder_entriesfollow_cardunfollow_cardfollow_invitationtick_entryuntick_entryset_due_notice

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.
404conversation_not_foundThe project the request names, or its chat, is not one the signed-in person is in.
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.
409project_profile_changedThe project's setup changed while the cards were read.
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/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards/3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48/reminders/7b4f2c91-5e8a-4d36-9a1c-3e7d0b5f2c84" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards/3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48/reminders/7b4f2c91-5e8a-4d36-9a1c-3e7d0b5f2c84", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "reminder": {
    "id": "7b4f2c91-5e8a-4d36-9a1c-3e7d0b5f2c84",
    "itemId": "3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48",
    "version": 1,
    "timeRevision": 1,
    "snoozeRevision": 0,
    "fireAt": "2026-11-24T13:00:00.000Z",
    "effectiveFireAt": "2026-11-24T13:00:00.000Z",
    "snoozedUntil": null,
    "setterTimeZone": "America/New_York",
    "text": "Call the supplier about delivery",
    "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": {
      "id": "7b4f2c91-5e8a-4d36-9a1c-3e7d0b5f2c84",
      "expectedVersion": 1
    },
    "actions": [
      "delete",
      "snooze_hour",
      "snooze_tomorrow",
      "invite_in_chat"
    ]
  },
  "item": {
    "outcome": "open",
    "id": "3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48",
    "ref": "#14",
    "title": "Order the quartz countertop",
    "language": "en-US",
    "status": {
      "key": "in_progress",
      "label": "In progress",
      "category": "active",
      "bucket": "in_progress"
    },
    "dueNoticeLead": "at_due",
    "due": {
      "kind": "datetime",
      "at": "2026-11-25T20:00:00.000Z",
      "enteredTimeZone": "America/New_York"
    },
    "dueSetBy": {
      "displayName": "Maya Chen"
    },
    "assignee": {
      "personId": "5d1f3a2e-8c4b-4e7a-9f21-3b6c8d0e1a42",
      "displayName": "Maya Chen",
      "initials": "MC"
    },
    "version": 7,
    "number": 14,
    "currentStep": {
      "id": "in_progress",
      "label": "In progress",
      "bucket": "in_progress"
    },
    "archived": false,
    "counts": {
      "photos": 0,
      "updates": 0,
      "documents": 1
    }
  }
}