Get the invitation link
The project's invitation link, one per project, valid 7 days.
Opening the link sends a request to join that the owner or an admin answers; it never joins by itself.
Authorization
Authorization: Bearer <key> Authentication
Path parameters
The project's id.
Response
200 The link, or null when the project has none.
The project's invitation link, or null when it has none.
Show properties of linkHide properties of link
The link's id.
The link's version; revoking it sends it as expectedVersion.
The invitation link to share. Opening it sends a join request, never joins.
When the link was made.
When the link stops working, 7 days after it was made.
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.personal_project_restricted The request acts on the signed-in person's own My Werk, which only they see, or on a reminder with no card, which lives there, and My Werk does not take this action.not_permitted The signed-in person's role, or whose the record is, does not allow this request.conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.project_not_found The project the request names is not one the signed-in person can reach.session_changed The session changed while the request was in flight.project_archived The project is archived, so it does not take this request.code_key_changed The invitation code or link was made with a key the server no longer holds.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/invitation-link" \
-H "Authorization: Bearer wk_key_..."const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/invitation-link", {
headers: {
Authorization: "Bearer wk_key_...",
},
});
const answer = await res.json();{
"link": {
"id": "e8c2a6f0-5d9b-4e17-a3c5-8f4d6b0e2c64",
"version": 1,
"url": "https://getwerk.ai/join/hs7Kq2mP9xRt4LwBvN3cJ8yZa5Qe1Ud6Gh0Fk2Ts9Xp",
"createdAt": "2026-11-20T15:00:00.000Z",
"expiresAt": "2026-11-27T15:00:00.000Z"
}
}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.