DevelopersHow to connect an assistantKeys
Reference/Reminders/Read

Get a reminder invitation

GEThttps://api.getwerk.ai/api/v1/projects/{projectId}/reminder-invitations/{invitationId}

An invitation to take a reminder that a person of the project shared with the key's person.

It holds the card, the time and who shared it; the reminder's text is read once the invitation is accepted. An invitation whose card or time no longer allows it is not 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.

invitationIdstring, uuidRequired

The invitation's id.

Response

200 The invitation.

invitationobject

The invitation.

Show properties of invitationHide properties of invitation
idstring, uuid

The invitation's id.

itemIdstring, uuid

The card the shared reminder is on.

versioninteger

The invitation's version; the answer sends it as expectedVersion.

At least 1
fireAtstring, date-time

The time the reminder is set for.

setterTimeZonestring

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

ownerobject

The person who shared 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

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_invitation_not_foundThe invitation to a shared reminder that the request names is not one waiting for the signed-in person.
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/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/reminder-invitations/e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/reminder-invitations/e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "invitation": {
    "id": "e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30",
    "itemId": "1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81",
    "version": 1,
    "fireAt": "2026-11-24T13:00:00.000Z",
    "setterTimeZone": "America/New_York",
    "owner": {
      "userId": "8a2e6c14-3f5d-4b9a-a7e2-61c0d9f4b3e8",
      "displayName": "Tom Okafor",
      "initials": "TO",
      "isViewer": false
    }
  }
}