DevelopersHow to connect an assistantKeys
Reference/Projects/Read

Get a project

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

One project, as the key's person's project list shows it.

It holds the project's name, people, counts of cards, Werk's line on how it is going, and what the key's person may do with it.

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 project.

conversationobject

The project.

Show properties of conversationHide properties of conversation
projectIdstring, uuid

The project's id.

colorenum

The color the key's person sees the project in.

Allowed valuespinktangerineyellowgreenturquoiseskyblueviolet
highlightedboolean

True when the key's person marked the project to stand out in their list.

appearanceRevisioninteger

Grows with each change to the key's person's color or mark for the project.

At least 1
idstring

The id Werk's apps use for the key's person's view of this project; the API's paths take projectId.

listPositioninteger or null

The key's person's own place for the project in their list, or null while they never ordered it.

peopleVersioninteger

The version of the project's people, which changes whenever its people do.

At least 1
statusLinestring or null

One line Werk writes from the project's cards on how the project is going, or null before there is one.

statusLineAtstring, date-time or null

When that line was written.

archivedboolean

True when the project is archived.

personalboolean

True for the key's person's own project, My Werk, which nobody else joins.

Defaultfalse
capabilitiesobject

What the key's person may do with the project now.

Show properties of capabilitiesHide properties of capabilities
inviteboolean

True when the key's person may invite people to the project.

managePeopleboolean

True when they may manage the project's people.

changeRolesboolean

True when they may make a person an admin or a member.

removePeopleboolean

True when they may remove people from the project.

editListsboolean

True when they may change the project's steps.

archiveboolean

True when they may archive the project.

restoreboolean

True when they may bring the project back from the archive.

deleteboolean

True when they may delete the project.

transferOwnershipboolean

True when they may hand the project to another person and leave it.

renameboolean

True when they may rename the project.

changePhotoboolean

True when they may change the project's photo.

leaveboolean

True when they may leave the project.

titlestring

The project's name.

lastActivityAtstring

When something last happened in the project that the key's person sees: a chat message or a card change.

isOwnerboolean

True when the key's person owns the project.

ownerNamestring

The owner's name.

memberCountinteger

How many people the project has.

At least 0
membersarray of objects

A few of the project's people, for its avatars.

Up to 3 items
Show properties of membersHide properties of members
idstring, uuid

The person's id.

firstNamestring

The person's first name.

initialsstring

The person's initials, for an avatar with no photo.

photoobject

The person's photo, when they have one.

Show properties of photoHide properties of photo
personIdstring, uuid

The person whose photo it is.

versioninteger

The photo's version, which changes with the photo; its read takes it to fetch the current one.

At least 1
viewerRoleenum

The key's person's role in the project.

Allowed valuesowneradminmembercollaborator
photoobject or null

The project's photo, or null when it has none.

Show properties of photoHide properties of photo
versioninteger

The photo's version, which changes with the photo; its read takes it to fetch the current one.

At least 1
dueTodayCountinteger

Open cards due today.

At least 0
closedCardCountinteger

Cards on the project's last step, archived ones included.

At least 0
openCardCountinteger

Cards neither archived nor on the project's last step.

At least 0
offerTranslationobject

Present while Werk offers the key's person to translate the project's cards that others wrote in other languages.

Show properties of offerTranslationHide properties of offerTranslation
languagesarray of strings

The languages those cards are written in.

From 1 to 20 items, each from 2 to 64 characters
targetstring

The key's person's language, which they would be translated into.

currentOpenCardCountinteger

The project's open cards, as its card list counts them.

At least 0
projectConfigVersioninteger

The version of the project's settings (its name, steps and archive), which grows with each change to them; such a change sends it as expectedConfigVersion.

At least 1

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" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "conversation": {
    "projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
    "color": "turquoise",
    "highlighted": false,
    "appearanceRevision": 1,
    "id": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
    "listPosition": 0,
    "peopleVersion": 3,
    "statusLine": "#12 Replace the leaking sink faucet is waiting for parts; two more cards are in progress.",
    "statusLineAt": "2026-11-21T13:40:00.000Z",
    "archived": false,
    "personal": false,
    "capabilities": {
      "invite": true,
      "managePeople": true,
      "changeRoles": true,
      "removePeople": true,
      "editLists": true,
      "archive": true,
      "restore": false,
      "delete": true,
      "transferOwnership": true,
      "rename": true,
      "changePhoto": true,
      "leave": true
    },
    "title": "Harbor Street kitchen",
    "lastActivityAt": "2026-11-21T13:35:00.000Z",
    "isOwner": true,
    "ownerName": "Maya Chen",
    "memberCount": 3,
    "members": [
      {
        "id": "5d1f3a2e-8c4b-4e7a-9f21-3b6c8d0e1a42",
        "firstName": "Maya",
        "initials": "MC"
      },
      {
        "id": "8a2e6c14-3f5d-4b9a-a7e2-61c0d9f4b3e8",
        "firstName": "Tom",
        "initials": "TO"
      },
      {
        "id": "c4b7e9a1-2d6f-4c83-b5a0-7e1f3d9c2b64",
        "firstName": "Lucia",
        "initials": "LF"
      }
    ],
    "viewerRole": "owner",
    "photo": {
      "version": 2
    },
    "dueTodayCount": 0,
    "closedCardCount": 4,
    "openCardCount": 3,
    "currentOpenCardCount": 3,
    "projectConfigVersion": 6
  }
}