DevelopersHow to connect an assistantKeys
Reference/People/Read

Get a join request

GEThttps://api.getwerk.ai/api/v1/account/join-requests/{requestId}

One of the key's person's own requests to join a project.

Only the key's person's own requests are found.

Authorization

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Path parameters

requestIdstring, uuidRequired

The request's id.

Response

200 The request.

requestobject

The request to join.

Show properties of requestHide properties of request
idstring, uuid

The join request's id.

versioninteger

The request's version; an answer to it sends it as expectedVersion.

At least 1
stateenum

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.

Allowed valuespendingapprovedrejectedcancelledexpired
createdAtstring, date-time

When the request was sent.

expiresAtstring, date-time

When the request lapses if nobody answers it.

resolvedAtstring, date-time or null

When it was answered, cancelled or lapsed, or null while pending.

projectNamestring

The name of the project the request is for.

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).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
404not_foundThe route or record the request names does not exist, or is not one the signed-in person can reach.
409session_changedThe session changed while the request was in flight.
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/join-requests/a9d3f7b1-6e0c-4a28-b4d6-9e5f7c1a3d75" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/account/join-requests/a9d3f7b1-6e0c-4a28-b4d6-9e5f7c1a3d75", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "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"
  }
}