Get a follow invitation
An invitation to follow a card, sent to or by the key's person.
One that was answered, lapsed, or whose card either person no longer sees is not found.
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.
Path parameters
The project's id.
The invitation's id.
Response
200 The invitation.
The invitation.
Show properties of invitationHide properties of invitation
The card the invitation is to follow.
The invitation's version; the answer sends it as expectedVersion.
When the invitation lapses if not answered.
Who sent the invitation.
Show properties of inviterHide properties of inviter
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 invitation's id.
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).session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.follow_invitation_not_found The invitation to follow a card that the request names is not one waiting for the signed-in person.session_changed The session changed while the request was in flight.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/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/follow-invitations/e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30" \
-H "Authorization: Bearer wk_key_..."const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/follow-invitations/e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30", {
headers: {
Authorization: "Bearer wk_key_...",
},
});
const answer = await res.json();{
"invitation": {
"id": "e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30",
"itemId": "1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81",
"version": 1,
"expiresAt": "2026-11-28T14:05:00.000Z",
"inviter": {
"userId": "8a2e6c14-3f5d-4b9a-a7e2-61c0d9f4b3e8",
"displayName": "Tom Okafor",
"initials": "TO",
"isViewer": 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.