List invitation codes
GEThttps://api.getwerk.ai/api/v1/projects/{projectId}/invitations
The invitation codes the key's person made for the project that are still unused, oldest first.
A code itself is shown only once, when it is made.
Authorization
AuthorizationheaderRequired
Authorization: Bearer <key> Authentication
Path parameters
projectIdstring, uuidRequired
The project's id.
Response
200 The codes still waiting.
invitationsarray of objects
The project's invitation codes still waiting to be used.
Show properties of invitationsHide properties of invitations
idstring, uuid
The invitation's id.
expiresAtstring, date-time
When the code stops working.
Errors
400
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).401
session_revoked The request carries no session the server holds, or its session has ended.401
session_expired The session has expired.403
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.403
not_permitted The signed-in person's role, or whose the record is, does not allow this request.404
conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.409
session_changed The session changed while the request was in flight.409
project_archived The project is archived, so it does not take this request.429
rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.500
server_error The 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/invitations" \
-H "Authorization: Bearer wk_key_..."TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/invitations", {
headers: {
Authorization: "Bearer wk_key_...",
},
});
const answer = await res.json();200JSON
{
"invitations": [
{
"id": "e1c6a4f8-0b3d-4e92-8f7a-5c2d9b1e6a30",
"expiresAt": "2026-11-22T14:05:00.000Z"
}
]
}Send a requestGET
It is sent with the key you give, as you. A change made here is real.
JSON
The request could not be sent, or its response could not be read.