List the agenda
What is due for the key's person, day by day: their reminders and the due dates of the cards they hold or follow.
Overdue entries come first, then each day in order. Done and archived cards are left out. Without before, the agenda covers 14 days from today.
Authorization
Authorization: Bearer <key> Authentication
Headers
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.
Query parameters
The cursor from the previous page's nextCursor; left out, the first page.
How many entries a page holds.
The first day left out, as YYYY-MM-DD in the key's person's time zone, after today; left out, 14 days from today.
Response
200 The agenda's page.
The cursor that reads the next page, or null when none remains.
True when more entries remain past this page.
The key's person's time zone, which the days are read in.
Today in that time zone.
The last day the agenda covers.
Due dates and reminders whose time has passed.
Show properties of overdueHide properties of overdue
One of 3 shapes, told apart by kind:
kinddueThe project the entry is in.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The card, or null for a reminder with no card.
Show properties of itemHide properties of item
completed when the card is on its project's last step, not_completed when it was archived before it, open otherwise.
The card's id.
The card's number as people write it, with # before it.
The card's title, as written.
The language the card's title and description are written in.
The title in the reader's language, when it is written in another.
Show properties of titleTranslationHide properties of titleTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
The step the card is on, with where that step sits in the work.
Show properties of statusHide properties of status
The id of the step the card is on.
The step's name.
open on a new step, done on the project's last step, active on any other step.
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.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
How long before the due date its holder and followers get the due notice; none sends no notice.
Who set the due moment; present only for a due date with a time.
Show properties of dueSetByHide properties of dueSetBy
That person's name.
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:
kinddatedate for a due day with no time, datetime for a due moment.
The due day, as YYYY-MM-DD.
kinddatetimedate for a due day with no time, datetime for a due moment.
The due moment, as an ISO 8601 date and time with its offset.
The time zone the due moment was given in, when known.
The card's holder, or null when the card is free.
Show properties of assigneeHide properties of assignee
The holder's person id.
The holder's name as the project shows it.
The holder's initials, for an avatar with no photo.
The holder's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The card's version, which grows with every change to it.
The card's number in its project, unique there and never reused.
The card's step among its project's steps, as the project defines it.
Show properties of currentStepHide properties of currentStep
The step's id; a change of step sends it as stepId.
The step's name.
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.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
True when the card is archived: it has left the working lists and stays readable and searchable.
How much the card holds.
Show properties of countsHide properties of counts
Photos on the card.
Updates on the card.
Documents on the card.
The card's list: its items checked and in all; absent when the card has no list.
Show properties of checklistHide properties of checklist
List items checked.
List items in all.
The changes the key's person may make to this card by hand now, by action name.
The day the entry falls on, in the key's person's time zone.
True when its time has passed.
Where Werk's apps open the entry.
Show properties of destinationHide properties of destination
One of 7 shapes, told apart by kind:
kindcardWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The card's id.
kindchatWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The chat message's id.
kindprojectWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindpeopleWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindcardless_What the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindplansWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindpulseWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
due for a card's due date, personal_reminder for a reminder on a card, personal_reminder_cardless for one with no card.
kindpersonal_The project the entry is in.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The card, or null for a reminder with no card.
Show properties of itemHide properties of item
completed when the card is on its project's last step, not_completed when it was archived before it, open otherwise.
The card's id.
The card's number as people write it, with # before it.
The card's title, as written.
The language the card's title and description are written in.
The title in the reader's language, when it is written in another.
Show properties of titleTranslationHide properties of titleTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
The step the card is on, with where that step sits in the work.
Show properties of statusHide properties of status
The id of the step the card is on.
The step's name.
open on a new step, done on the project's last step, active on any other step.
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.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
How long before the due date its holder and followers get the due notice; none sends no notice.
Who set the due moment; present only for a due date with a time.
Show properties of dueSetByHide properties of dueSetBy
That person's name.
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:
kinddatedate for a due day with no time, datetime for a due moment.
The due day, as YYYY-MM-DD.
kinddatetimedate for a due day with no time, datetime for a due moment.
The due moment, as an ISO 8601 date and time with its offset.
The time zone the due moment was given in, when known.
The card's holder, or null when the card is free.
Show properties of assigneeHide properties of assignee
The holder's person id.
The holder's name as the project shows it.
The holder's initials, for an avatar with no photo.
The holder's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The card's version, which grows with every change to it.
The card's number in its project, unique there and never reused.
The card's step among its project's steps, as the project defines it.
Show properties of currentStepHide properties of currentStep
The step's id; a change of step sends it as stepId.
The step's name.
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.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
True when the card is archived: it has left the working lists and stays readable and searchable.
How much the card holds.
Show properties of countsHide properties of counts
Photos on the card.
Updates on the card.
Documents on the card.
The card's list: its items checked and in all; absent when the card has no list.
Show properties of checklistHide properties of checklist
List items checked.
List items in all.
The changes the key's person may make to this card by hand now, by action name.
The day the entry falls on, in the key's person's time zone.
True when its time has passed.
Where Werk's apps open the entry.
Show properties of destinationHide properties of destination
One of 7 shapes, told apart by kind:
kindcardWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The card's id.
kindchatWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The chat message's id.
kindprojectWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindpeopleWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindcardless_What the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindplansWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindpulseWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
due for a card's due date, personal_reminder for a reminder on a card, personal_reminder_cardless for one with no card.
The reminder, on a reminder's entry.
Show properties of reminderHide properties of reminder
The reminder's id.
The card the reminder is on.
The reminder's version, which grows with every change to it; a change sends it as expectedVersion.
Grows each time the reminder's time changes; a change sends it as expectedTimeRevision.
Grows each time the key's person snoozes the reminder; a change sends it as expectedSnoozeRevision.
The time its owner set the reminder for.
When the reminder goes off for the key's person: the snoozed time, else the set time.
The time the key's person snoozed the reminder to, or null.
The time zone the reminder's time was set in.
The reminder's text, as its owner wrote it.
The language a shared reminder's text is written in.
A shared reminder's text in the reader's language, when it is written in another.
Show properties of translationHide properties of translation
The reader's language the text is translated into.
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.
The translated text, present once ready.
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.
Whose reminder it is and who it is shared with.
Show properties of audienceHide properties of audience
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.
Who the reminder is for, in one line in the reader's language.
The person who set the reminder.
Show properties of ownerHide properties of owner
The person's id.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The people the owner shared the reminder with who accepted it.
Show properties of invitedHide properties of invited
The person's id.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
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
The reminder's id.
The reminder's version as last read.
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.
kindpersonal_The project the entry is in.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The card, or null for a reminder with no card.
The day the entry falls on, in the key's person's time zone.
True when its time has passed.
Where Werk's apps open the entry.
Show properties of destinationHide properties of destination
One of 7 shapes, told apart by kind:
kindcardWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The card's id.
kindchatWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The chat message's id.
kindprojectWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindpeopleWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindcardless_What the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindplansWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindpulseWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
due for a card's due date, personal_reminder for a reminder on a card, personal_reminder_cardless for one with no card.
The reminder, on a reminder's entry.
Show properties of reminderHide properties of reminder
The reminder's id.
Always null: this reminder has no card.
The reminder's version, which grows with every change to it; a change sends it as expectedVersion.
Grows each time the reminder's time changes; a change sends it as expectedTimeRevision.
Grows each time the key's person snoozes the reminder; a change sends it as expectedSnoozeRevision.
The time its owner set the reminder for.
When the reminder goes off for the key's person: the snoozed time, else the set time.
The time the key's person snoozed the reminder to, or null.
The time zone the reminder's time was set in.
The reminder's text, as its owner wrote it.
The language a shared reminder's text is written in.
A shared reminder's text in the reader's language, when it is written in another.
Show properties of translationHide properties of translation
The reader's language the text is translated into.
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.
The translated text, present once ready.
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.
Whose reminder it is and who it is shared with.
Show properties of audienceHide properties of audience
Always only_you: a reminder with no card is never shared.
Who the reminder is for, in one line in the reader's language.
The person who set the reminder.
Show properties of ownerHide properties of owner
The person's id.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
Always empty: a reminder with no card is never shared.
Show properties of invitedHide properties of invited
The person's id.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
Always null for a reminder with no card.
What the key's person may do with the reminder now.
Each day with something on it, in order.
Show properties of daysHide properties of days
The day.
What falls on that day: due dates first, then reminders by time.
Show properties of entriesHide properties of entries
One of 3 shapes, told apart by kind:
kinddueThe project the entry is in.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The card, or null for a reminder with no card.
Show properties of itemHide properties of item
completed when the card is on its project's last step, not_completed when it was archived before it, open otherwise.
The card's id.
The card's number as people write it, with # before it.
The card's title, as written.
The language the card's title and description are written in.
The title in the reader's language, when it is written in another.
Show properties of titleTranslationHide properties of titleTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
The step the card is on, with where that step sits in the work.
Show properties of statusHide properties of status
The id of the step the card is on.
The step's name.
open on a new step, done on the project's last step, active on any other step.
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.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
How long before the due date its holder and followers get the due notice; none sends no notice.
Who set the due moment; present only for a due date with a time.
Show properties of dueSetByHide properties of dueSetBy
That person's name.
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:
kinddatedate for a due day with no time, datetime for a due moment.
The due day, as YYYY-MM-DD.
kinddatetimedate for a due day with no time, datetime for a due moment.
The due moment, as an ISO 8601 date and time with its offset.
The time zone the due moment was given in, when known.
The card's holder, or null when the card is free.
Show properties of assigneeHide properties of assignee
The holder's person id.
The holder's name as the project shows it.
The holder's initials, for an avatar with no photo.
The holder's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The card's version, which grows with every change to it.
The card's number in its project, unique there and never reused.
The card's step among its project's steps, as the project defines it.
Show properties of currentStepHide properties of currentStep
The step's id; a change of step sends it as stepId.
The step's name.
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.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
True when the card is archived: it has left the working lists and stays readable and searchable.
How much the card holds.
Show properties of countsHide properties of counts
Photos on the card.
Updates on the card.
Documents on the card.
The card's list: its items checked and in all; absent when the card has no list.
Show properties of checklistHide properties of checklist
List items checked.
List items in all.
The changes the key's person may make to this card by hand now, by action name.
The day the entry falls on, in the key's person's time zone.
True when its time has passed.
Where Werk's apps open the entry.
Show properties of destinationHide properties of destination
One of 7 shapes, told apart by kind:
kindcardWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The card's id.
kindchatWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The chat message's id.
kindprojectWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindpeopleWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindcardless_What the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindplansWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindpulseWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
due for a card's due date, personal_reminder for a reminder on a card, personal_reminder_cardless for one with no card.
kindpersonal_The project the entry is in.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The card, or null for a reminder with no card.
Show properties of itemHide properties of item
completed when the card is on its project's last step, not_completed when it was archived before it, open otherwise.
The card's id.
The card's number as people write it, with # before it.
The card's title, as written.
The language the card's title and description are written in.
The title in the reader's language, when it is written in another.
Show properties of titleTranslationHide properties of titleTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
The step the card is on, with where that step sits in the work.
Show properties of statusHide properties of status
The id of the step the card is on.
The step's name.
open on a new step, done on the project's last step, active on any other step.
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.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
How long before the due date its holder and followers get the due notice; none sends no notice.
Who set the due moment; present only for a due date with a time.
Show properties of dueSetByHide properties of dueSetBy
That person's name.
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:
kinddatedate for a due day with no time, datetime for a due moment.
The due day, as YYYY-MM-DD.
kinddatetimedate for a due day with no time, datetime for a due moment.
The due moment, as an ISO 8601 date and time with its offset.
The time zone the due moment was given in, when known.
The card's holder, or null when the card is free.
Show properties of assigneeHide properties of assignee
The holder's person id.
The holder's name as the project shows it.
The holder's initials, for an avatar with no photo.
The holder's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The card's version, which grows with every change to it.
The card's number in its project, unique there and never reused.
The card's step among its project's steps, as the project defines it.
Show properties of currentStepHide properties of currentStep
The step's id; a change of step sends it as stepId.
The step's name.
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.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
True when the card is archived: it has left the working lists and stays readable and searchable.
How much the card holds.
Show properties of countsHide properties of counts
Photos on the card.
Updates on the card.
Documents on the card.
The card's list: its items checked and in all; absent when the card has no list.
Show properties of checklistHide properties of checklist
List items checked.
List items in all.
The changes the key's person may make to this card by hand now, by action name.
The day the entry falls on, in the key's person's time zone.
True when its time has passed.
Where Werk's apps open the entry.
Show properties of destinationHide properties of destination
One of 7 shapes, told apart by kind:
kindcardWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The card's id.
kindchatWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The chat message's id.
kindprojectWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindpeopleWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindcardless_What the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindplansWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindpulseWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
due for a card's due date, personal_reminder for a reminder on a card, personal_reminder_cardless for one with no card.
The reminder, on a reminder's entry.
Show properties of reminderHide properties of reminder
The reminder's id.
The card the reminder is on.
The reminder's version, which grows with every change to it; a change sends it as expectedVersion.
Grows each time the reminder's time changes; a change sends it as expectedTimeRevision.
Grows each time the key's person snoozes the reminder; a change sends it as expectedSnoozeRevision.
The time its owner set the reminder for.
When the reminder goes off for the key's person: the snoozed time, else the set time.
The time the key's person snoozed the reminder to, or null.
The time zone the reminder's time was set in.
The reminder's text, as its owner wrote it.
The language a shared reminder's text is written in.
A shared reminder's text in the reader's language, when it is written in another.
Show properties of translationHide properties of translation
The reader's language the text is translated into.
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.
The translated text, present once ready.
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.
Whose reminder it is and who it is shared with.
Show properties of audienceHide properties of audience
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.
Who the reminder is for, in one line in the reader's language.
The person who set the reminder.
Show properties of ownerHide properties of owner
The person's id.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The people the owner shared the reminder with who accepted it.
Show properties of invitedHide properties of invited
The person's id.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
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
The reminder's id.
The reminder's version as last read.
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.
kindpersonal_The project the entry is in.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The card, or null for a reminder with no card.
The day the entry falls on, in the key's person's time zone.
True when its time has passed.
Where Werk's apps open the entry.
Show properties of destinationHide properties of destination
One of 7 shapes, told apart by kind:
kindcardWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The card's id.
kindchatWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
The chat message's id.
kindprojectWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindpeopleWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
The id Werk's apps use for the key's person's view of the project; the API's paths take projectId.
The project's id.
kindcardless_What the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindplansWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
kindpulseWhat the apps open: a card, a chat message, a project, its people, the reminders with no card, the plans or Pulse.
due for a card's due date, personal_reminder for a reminder on a card, personal_reminder_cardless for one with no card.
The reminder, on a reminder's entry.
Show properties of reminderHide properties of reminder
The reminder's id.
Always null: this reminder has no card.
The reminder's version, which grows with every change to it; a change sends it as expectedVersion.
Grows each time the reminder's time changes; a change sends it as expectedTimeRevision.
Grows each time the key's person snoozes the reminder; a change sends it as expectedSnoozeRevision.
The time its owner set the reminder for.
When the reminder goes off for the key's person: the snoozed time, else the set time.
The time the key's person snoozed the reminder to, or null.
The time zone the reminder's time was set in.
The reminder's text, as its owner wrote it.
The language a shared reminder's text is written in.
A shared reminder's text in the reader's language, when it is written in another.
Show properties of translationHide properties of translation
The reader's language the text is translated into.
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.
The translated text, present once ready.
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.
Whose reminder it is and who it is shared with.
Show properties of audienceHide properties of audience
Always only_you: a reminder with no card is never shared.
Who the reminder is for, in one line in the reader's language.
The person who set the reminder.
Show properties of ownerHide properties of owner
The person's id.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
Always empty: a reminder with no card is never shared.
Show properties of invitedHide properties of invited
The person's id.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
Always null for a reminder with no card.
What the key's person may do with the reminder now.
Errors
invalid_query The 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).invalid_limit The page size, or the number of entries asked, is not one the list takes.invalid_card_query The request about cards or their files is not in the form its route takes, or names a day of a filter while the signed-in person's profile has no time zone; 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).session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.session_changed The session changed while the request was in flight.cursor_expired The page cursor no longer fits the list as it stands or the arguments it was read with.project_profile_changed The project's setup changed while the cards were read.rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.server_error The server could not complete the request, and it is not known whether a write it holds was made.curl "https://api.getwerk.ai/api/v1/agenda?limit=50" \
-H "Authorization: Bearer wk_key_..."const res = await fetch("https://api.getwerk.ai/api/v1/agenda?limit=50", {
headers: {
Authorization: "Bearer wk_key_...",
},
});
const answer = await res.json();{
"nextCursor": null,
"hasMore": false,
"timeZone": "America/New_York",
"today": "2026-11-21",
"through": "2026-12-04",
"overdue": [],
"days": [
{
"day": "2026-11-24",
"entries": [
{
"kind": "personal_reminder",
"projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
"conversationId": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
"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
}
},
"day": "2026-11-24",
"overdue": false,
"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"
]
}
}
]
},
{
"day": "2026-11-25",
"entries": [
{
"kind": "due",
"projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
"conversationId": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
"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
}
},
"day": "2026-11-25",
"overdue": false
}
]
}
]
}Send a requestGET
It is sent with the key you give, as you. A change made here is real.
The request could not be sent, or its response could not be read.