DevelopersHow to connect an assistantKeys
Reference/People/Read

List joins by code

GEThttps://api.getwerk.ai/api/v1/projects/{projectId}/joins

The people who joined the project with the key's person's invitation codes and are still in it.

Oldest first.

Authorization

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Headers

Werk-Localestring

The language tag Werk writes the answer's own words in, such as step names and history lines, matched to a language it serves; a card's text stays as written. At a project's paths, the reads of its cards and steps, of a card, its update photos, a file and its reminders, and of follow and reminder invitations, and a document's read-now and consent, take the language of the person's chat with Werk in that project first, while it has one. Without either, the language Werk uses with the person the key or the connection acts for.

Path parameters

projectIdstring, uuidRequired

The project's id.

Response

200 The joins.

joinsarray of objects

Notices that someone joined one of the key's person's projects with an invitation.

Show properties of joinsHide properties of joins
idstring, uuid

The notice's id.

namestring

The name of the person who joined.

From 1 to 128 characters
projectobject

The project they joined.

Show properties of projectHide properties of project
idstring, uuid

The id Werk's apps use for the key's person's view of the project, not the project's id.

projectIdstring, uuid

The project's id, the one the API's paths take.

namestring

The project's name.

From 1 to 128 characters
joinedAtstring, date-time

When they joined.

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.
404conversation_not_foundThe project the request names, or its chat, is not one the signed-in person is in.
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/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/joins" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/joins", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "joins": [
    {
      "id": "d2a6c0e4-9b3f-4d5b-87a9-2b8c0f4d6a08",
      "name": "Lucia Ferraro",
      "project": {
        "id": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
        "name": "Harbor Street kitchen"
      },
      "joinedAt": "2026-11-19T10:00:00.000Z"
    }
  ]
}