DevelopersHow to connect an assistantKeys
Reference/Cards/Read

List my invitations

GEThttps://api.getwerk.ai/api/v1/account/invitations

The invitations waiting for the key's person's answer across their projects: to follow a card, and to take a shared reminder.

Newest first. A shared reminder's text is read once it is accepted.

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.

Query parameters

afterstring

The cursor from the previous page's nextCursor; left out, the first page.

limitinteger

How many invitations a page holds.

From 1 to 100
Default50

Response

200 The invitations.

invitationsarray of objects

The invitations waiting for the key's person's answer, newest first.

Show properties of invitationsHide properties of invitations
kindenum

follow for an invitation to follow a card, reminder for a reminder shared with the key's person.

Allowed valuesfollowreminder
idstring, uuid

The invitation's id.

versioninteger

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

At least 1
expiresAtstring, date-time

When the invitation lapses if not answered.

projectIdstring, uuid

The project the card is in.

projectNamestring

The project's name.

itemobject

The card the invitation is about.

Show properties of itemHide properties of item
idstring, uuid

The card's id.

numberinteger or null

The card's number.

titlestring

The card's title.

inviterobject

Who sent the invitation.

Show properties of inviterHide properties of inviter
userIdstring, uuid

The person's id.

displayNamestring

The person's name.

fireAtstring, date-time

For a shared reminder, the time it is set for.

nextCursorstring or null

The cursor that reads the next page as after, or null when none remains.

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_limitThe page size, or the number of entries asked, is not one the list takes.
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
409session_changedThe session changed while the request was in flight.
409cursor_expiredThe page cursor no longer fits the list as it stands or the arguments it was read with.
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/account/invitations?limit=20" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/account/invitations?limit=20", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "invitations": [
    {
      "kind": "reminder",
      "id": "e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30",
      "version": 1,
      "expiresAt": "2026-11-24T13:00:00.000Z",
      "projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
      "projectName": "Harbor Street kitchen",
      "item": {
        "id": "1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81",
        "number": 12,
        "title": "Replace the leaking sink faucet"
      },
      "inviter": {
        "userId": "8a2e6c14-3f5d-4b9a-a7e2-61c0d9f4b3e8",
        "displayName": "Tom Okafor"
      },
      "fireAt": "2026-11-24T13:00:00.000Z"
    }
  ],
  "nextCursor": null
}