Ask to join by link
Sends a request to join the project an invitation link leads to, for the owner and admins to answer.
Until it is accepted the key's person sees only the project's name. Asking again on the same link answers the request already sent; a person makes at most 10 attempts an hour.
Authorization
Authorization: Bearer <key> Authentication
Body
An id the caller makes for this request. Sent again with the same request, it returns the first answer and changes nothing twice; sent with a different request, it is refused.
The invitation link, as shared.
Response
200 The request to join, or why none was sent.
One of 2 shapes:
requestThe request to join.
Show properties of requestHide properties of request
The join request's id.
The request's version; an answer to it sends it as expectedVersion.
pending while it waits for an answer, approved or rejected once answered, cancelled when the link it came from was revoked, expired when nobody answered in time.
When the request was sent.
When the request lapses if nobody answers it.
When it was answered, cancelled or lapsed, or null while pending.
The name of the project the request is for.
kindinvalid, expired or revoked when the link does not work; already_member when the key's person is in the project.
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).invalid_people_request The people request 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.session_changed The session changed while the request was in flight.request_conflict The request id was already used with another request, or the change it asks could not be made to the record it names.request_erased The request id belongs to a request whose record was erased.payload_too_large The request body has more bytes than the route takes.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 -X POST "https://api.getwerk.ai/api/v1/project-invitation-links/request" \
-H "Authorization: Bearer wk_key_..." \
-H "Content-Type: application/json" \
-d '{
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4d09",
"url": "https://getwerk.ai/join/hs7Kq2mP9xRt4LwBvN3cJ8yZa5Qe1Ud6Gh0Fk2Ts9Xp"
}'const res = await fetch("https://api.getwerk.ai/api/v1/project-invitation-links/request", {
method: "POST",
headers: {
Authorization: "Bearer wk_key_...",
"Content-Type": "application/json",
},
body: JSON.stringify({
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4d09",
"url": "https://getwerk.ai/join/hs7Kq2mP9xRt4LwBvN3cJ8yZa5Qe1Ud6Gh0Fk2Ts9Xp"
}),
});
const answer = await res.json();{
"request": {
"id": "a9d3f7b1-6e0c-4a28-b4d6-9e5f7c1a3d75",
"version": 1,
"state": "pending",
"createdAt": "2026-11-20T18:10:00.000Z",
"expiresAt": "2026-12-20T18:10:00.000Z",
"resolvedAt": null,
"projectName": "Harbor Street kitchen"
}
}Send a requestPOST
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.