DevelopersHow to connect an assistantKeys
Reference/Cards/Read

List an update's photos

GEThttps://api.getwerk.ai/api/v1/projects/{projectId}/cards/{cardId}/updates/{updateId}/photos

One page of the photos that came with one of a card's updates.

An update shows its first photos within the card; this reads the rest.

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.

cardIdstring, uuidRequired

The card's id.

updateIdstring, uuidRequired

The update's id.

Query parameters

limitinteger

How many photos a page holds.

From 1 to 100
Default50
beforestring

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

From 1 to 512 characters

Response

200 The page of photos.

entriesarray of objects

The photos on this page, newest first.

Up to 100 items
Show properties of entriesHide properties of entries
idstring, uuid

The photo's id on the card; removing it names this id.

attachedByobject or null

Who added the photo, or null when no longer known.

Show properties of attachedByHide properties of attachedBy

One of 3 shapes, told apart by kind:

kinduser
kindenum

user for a person; connector or schedule for a change Werk made without one.

Allowed valuesuser
displayNamestring

The person's name as the project shows it.

At least 1 character
initialsstring

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

isViewerboolean

True when the person is the key's own person.

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
viaobject

The connected app or API key the change came through; absent for a change made in Werk's apps.

Show properties of viaHide properties of via
kindenum

connection for an app connected by sign-in, key for an API key.

Allowed valuesconnectionkey
namestring

The app's or the key's name, as Werk shows it.

At least 1 character
verifiedboolean

True when Werk verified the app's identity.

labelstring

The caption Werk shows beside the change, in the reader's language.

At least 1 character
kindconnector
kindenum

user for a person; connector or schedule for a change Werk made without one.

Allowed valuesconnector
labelstring

The name Werk shows for a change made without a person.

At least 1 character
kindschedule
kindenum

user for a person; connector or schedule for a change Werk made without one.

Allowed valuesschedule
labelstring

The name Werk shows for a change made without a person.

At least 1 character
assetobject

The photo's file.

Show properties of assetHide properties of asset
idstring, uuid

The file's id.

kindenum

What the file is: a photo, a voice recording or a document.

Allowed valuesimage
filenamestring

The document's name; only a document has one.

From 1 to 255 characters
formatenum

The document's format; only a document has one.

Allowed valuespdfdocxxlsxcsvtxtmd
mimeTypestring

The file's media type.

At least 1 character
sizeBytesinteger

The file's size in bytes.

At least 0
widthinteger

The photo's width in pixels; absent on photos stored before sizes were kept.

At least 1
heightinteger

The photo's height in pixels; absent on photos stored before sizes were kept.

At least 1
durationSecondsnumber

The recording's length in seconds; only a voice recording has one.

More than 0, up to 300
availableboolean

False once the file's bytes were released and it can no longer be read.

attachedAtstring, date-time

When the photo was added to the card.

removableboolean

True when the key's person may take this photo off the card now.

hasMoreboolean

True when older photos remain past this page.

nextCursorstring or null

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

From 1 to 512 characters

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_cursorThe page cursor is not one this list gave.
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
403project_not_permittedThe signed-in person's role in the project does not allow this request on the project.
404conversation_not_foundThe project the request names, or its chat, is not one the signed-in person is in.
404item_not_foundThe card the request names, or its list, is not one the signed-in person can see.
404update_not_foundThe update the request names is not on the card.
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.
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/cards/1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81/updates/c9a3e7f1-4d6b-4f80-a2c8-5b1e9d3f7a46/photos" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards/1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81/updates/c9a3e7f1-4d6b-4f80-a2c8-5b1e9d3f7a46/photos", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "entries": [
    {
      "id": "b8f2d6a4-3e1c-4b79-9d05-6a3e8c2f1b97",
      "attachedBy": {
        "kind": "user",
        "displayName": "Tom Okafor",
        "initials": "TO",
        "isViewer": false
      },
      "asset": {
        "id": "f3a9c1e7-5b2d-4c68-a4e0-9d7b3f1c5e82",
        "kind": "image",
        "mimeType": "image/jpeg",
        "sizeBytes": 482113,
        "width": 1600,
        "height": 1200
      },
      "attachedAt": "2026-11-19T16:12:00.000Z",
      "removable": true
    }
  ],
  "hasMore": false,
  "nextCursor": null
}