DevelopersHow to connect an assistantKeys
Reference/People/Read

List a project's join requests

GEThttps://api.getwerk.ai/api/v1/projects/{projectId}/join-requests

The requests to join the project still waiting for an answer, newest first.

The owner and the admins who may invite read them.

Authorization

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Path parameters

projectIdstring, uuidRequired

The project's id.

Query parameters

limitstring

How many requests a page holds.

afterstring

The cursor from the previous page's nextCursor; left out, the first page.

From 1 to 512 characters

Response

200 The requests.

requestsarray of objects

The requests to join the project.

Show properties of requestsHide properties of requests
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.

requesterobject

The person asking to join.

Show properties of requesterHide properties of requester
idstring, uuid

The person's id.

displayNamestring

The person's name.

From 1 to 128 characters
nextCursorstring or null

The cursor that reads the next page as after, or null when none remains.

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).
400invalid_people_requestThe 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).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
403personal_project_restrictedThe 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.
403not_permittedThe signed-in person's role, or whose the record is, does not allow this request.
404conversation_not_foundThe project the request names, or its chat, is not one the signed-in person is in.
404project_not_foundThe project the request names is not one the signed-in person can reach.
409session_changedThe session changed while the request was in flight.
409cursor_expiredThe page cursor no longer fits the list as it stands or the arguments it was read with.
409project_archivedThe project is archived, so it does not take this request.
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/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/join-requests?limit=20" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/join-requests?limit=20", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "requests": [
    {
      "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,
      "requester": {
        "id": "1b2c3d4e-5f60-4718-9a2b-3c4d5e6f7a81",
        "displayName": "Sam Rivera"
      }
    }
  ],
  "nextCursor": null
}