DevelopersHow to connect an assistantKeys
Reference/Cards/Read

Get a card

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

A card whole: its fields, description, list, followers, reminders, documents, and its photos, updates and history, newest first.

The photos, updates and history come one page each; their cursors read older pages through the same route.

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.

Query parameters

photosLimitinteger

How many of the card's photos the answer holds.

From 1 to 100
Default50
photosBeforestring

The photos' nextCursor from an earlier answer, to read older photos.

From 1 to 512 characters
updatesLimitinteger

How many of the card's updates the answer holds.

From 1 to 50
Default20
updatesBeforestring

The updates' nextCursor from an earlier answer, to read older updates.

From 1 to 512 characters
historyLimitinteger

How many history entries the answer holds.

From 1 to 100
Default50
historyBeforestring

The history's nextCursor from an earlier answer, to read older entries.

From 1 to 512 characters

Response

200 The card.

followersarray of objects

The people who follow the card.

Up to 100 items
Show properties of followersHide properties of followers

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
followingboolean

True when the key's person follows the card.

checklistobject

The card's list of items to check off.

Show properties of checklistHide properties of checklist
revisioninteger

The list's revision, which grows with every change to it; a change to the list sends it as expectedRevision.

At least 0
batchesarray of objects

The sets of items added together in one change.

Default[]
Show properties of batchesHide properties of batches
idstring, uuid

The set's id, which each of its items names as batch.

itemIdstring, uuid

The card's id.

authorIdstring, uuid or null

The person who added the set, or null when no person did.

createdAtstring, date-time

When the set was added.

groupIdstring, uuid

The id of the change that added the set.

itemsarray of objects

The list's items, in their order.

Show properties of itemsHide properties of items
idstring, uuid

The item's id.

positioninteger

The item's place in the list, from 0.

At least 0
batchstring, uuid or null

The id of the set the item was added in, or null when it was added on its own.

Defaultnull
textstring

The item's text, as written.

At least 1 character
translationobject

The text in the reader's language, when it is written in another.

Show properties of translationHide properties of translation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

checkedboolean

True when the item is checked.

checkedAtstring, date-time or null

When the item was checked, or null while it is not.

checkedByobject or null

Who checked the item, or null while it is not checked.

Show properties of checkedByHide properties of checkedBy

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
countsobject

The list's items checked and in all.

Show properties of countsHide properties of counts
doneinteger

List items checked.

At least 0
totalinteger

List items in all.

At least 0
remindersobject

The reminders the key's person sees on this card: the first three and how many in all.

Show properties of remindersHide properties of reminders
remindersarray of objects

The next three upcoming reminders, soonest first.

Up to 3 items
Show properties of remindersHide properties of reminders
idstring, uuid

The reminder's id.

itemIdstring, uuid

The card the reminder is on.

versioninteger

The reminder's version, which grows with every change to it; a change sends it as expectedVersion.

At least 1
timeRevisioninteger

Grows each time the reminder's time changes; a change sends it as expectedTimeRevision.

At least 1
snoozeRevisioninteger

Grows each time the key's person snoozes the reminder; a change sends it as expectedSnoozeRevision.

At least 0
fireAtstring, date-time or null

The time its owner set the reminder for.

effectiveFireAtstring, date-time or null

When the reminder goes off for the key's person: the snoozed time, else the set time.

snoozedUntilstring, date-time or null

The time the key's person snoozed the reminder to, or null.

setterTimeZonestring

The time zone the reminder's time was set in.

textstring or null

The reminder's text, as its owner wrote it.

languagestring

The language a shared reminder's text is written in.

From 2 to 64 characters
translationobject

A shared reminder's text in the reader's language, when it is written in another.

Show properties of translationHide properties of translation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

stateenum

upcoming before it goes off, past once it went off, dropped when it will not go off, its card done, archived or out of reach.

Allowed valuesupcomingpastdropped
audienceobject

Whose reminder it is and who it is shared with.

Show properties of audienceHide properties of audience
kindenum

only_you for the key's person's own reminder shared with nobody, invited_by_you for their own reminder shared with others, from_owner for a reminder someone shared with them.

Allowed valuesonly_youinvited_by_youfrom_owner
labelstring

Who the reminder is for, in one line in the reader's language.

ownerobject

The person who set the reminder.

Show properties of ownerHide properties of owner
userIdstring, uuid

The person's id.

displayNamestring

The person's name as the project shows it.

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
invitedarray of objects

The people the owner shared the reminder with who accepted it.

Show properties of invitedHide properties of invited
userIdstring, uuid

The person's id.

displayNamestring

The person's name as the project shows it.

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
quotedReminderRefobject or null

The reminder's id and version as Werk's apps quote it in a chat message; null on a reminder shared by someone else.

Show properties of quotedReminderRefHide properties of quotedReminderRef
idstring, uuid

The reminder's id.

expectedVersioninteger

The reminder's version as last read.

At least 1
actionsarray of enums

What the key's person may do with the reminder now: delete their own, remove a shared one from their list, snooze it, share it.

Allowed valuesdeleteremovesnooze_hoursnooze_tomorrowinvite_in_chat
totalinteger

How many reminders there are in all, past and dropped ones included.

At least 0
documentsobject

The documents on the card.

Show properties of documentsHide properties of documents
documentsarray of objects

The card's first three documents.

Up to 3 items
Show properties of documentsHide properties of documents
idstring, uuid

The document's id.

itemIdstring, uuid

The card the document is on.

filenamestring

The document's name.

From 1 to 255 characters
mimeTypeenum

The document's media type.

Allowed valuesapplication/pdfapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheettext/csvtext/plaintext/markdown
revisioninteger

The document's revision, which grows each time its file is replaced.

At least 1
stateenum

not_read while it is not being read, awaiting_confirmation while Werk waits for a yes to its cost, reading, failed, or ready.

Allowed valuesnot_readawaiting_confirmationreadingfailedready
versioninteger

The document's version, which grows with every change to it; a read request sends it as expectedVersion.

At least 1
totalSourcesinteger or null

How many parts the document has, or null while not known.

At least 0
readSourcesinteger

How many parts Werk read.

At least 0
truncatedboolean

True when Werk read only the document's first parts.

summarystring or null

Werk's summary of the document, or null.

From 1 to 2000 characters
fieldsobject or null

The issuer, number, date, total and currency Werk read in the document, or null.

Show properties of fieldsHide properties of fields
issuerobject or null

The issuer Werk read in the document, or null when it found none.

Show properties of issuerHide properties of issuer
valuestring

The issuer as read.

From 1 to 512 characters
sourceobject

The part of the document it was read from.

Show properties of sourceHide properties of source
documentIdstring

The document's id.

At least 1 character
revisioninteger

The revision it was read in.

At least 1
pageinteger

The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.

At least 1
sha256string

The SHA-256 of the file it was read from.

locationobject

Where in the file the part is.

Show properties of locationHide properties of location

One of 5 shapes, told apart by kind:

kindpdf_page
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuespdf_page
pageinteger

The PDF page.

At least 1
kindsection
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessection
sectioninteger

The section, counted from 1.

At least 1
kindparagraph
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuesparagraph
paragraphinteger

The paragraph, counted from 1.

At least 1
kindsheet_rows
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessheet_rows
sheetstring

The sheet's name.

At least 1 character
firstRowinteger

The part's first row.

At least 1
lastRowinteger

The part's last row.

At least 1
kindlines
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valueslines
firstLineinteger

The part's first line.

At least 1
lastLineinteger

The part's last line.

At least 1
numberobject or null

The document's number Werk read in the document, or null when it found none.

Show properties of numberHide properties of number
valuestring

The document's number as read.

From 1 to 128 characters
sourceobject

The part of the document it was read from.

Show properties of sourceHide properties of source
documentIdstring

The document's id.

At least 1 character
revisioninteger

The revision it was read in.

At least 1
pageinteger

The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.

At least 1
sha256string

The SHA-256 of the file it was read from.

locationobject

Where in the file the part is.

Show properties of locationHide properties of location

One of 5 shapes, told apart by kind:

kindpdf_page
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuespdf_page
pageinteger

The PDF page.

At least 1
kindsection
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessection
sectioninteger

The section, counted from 1.

At least 1
kindparagraph
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuesparagraph
paragraphinteger

The paragraph, counted from 1.

At least 1
kindsheet_rows
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessheet_rows
sheetstring

The sheet's name.

At least 1 character
firstRowinteger

The part's first row.

At least 1
lastRowinteger

The part's last row.

At least 1
kindlines
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valueslines
firstLineinteger

The part's first line.

At least 1
lastLineinteger

The part's last line.

At least 1
dateobject or null

The date Werk read in the document, or null when it found none.

Show properties of dateHide properties of date
valuestring, date

The date as read, as YYYY-MM-DD.

sourceobject

The part of the document it was read from.

Show properties of sourceHide properties of source
documentIdstring

The document's id.

At least 1 character
revisioninteger

The revision it was read in.

At least 1
pageinteger

The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.

At least 1
sha256string

The SHA-256 of the file it was read from.

locationobject

Where in the file the part is.

Show properties of locationHide properties of location

One of 5 shapes, told apart by kind:

kindpdf_page
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuespdf_page
pageinteger

The PDF page.

At least 1
kindsection
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessection
sectioninteger

The section, counted from 1.

At least 1
kindparagraph
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuesparagraph
paragraphinteger

The paragraph, counted from 1.

At least 1
kindsheet_rows
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessheet_rows
sheetstring

The sheet's name.

At least 1 character
firstRowinteger

The part's first row.

At least 1
lastRowinteger

The part's last row.

At least 1
kindlines
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valueslines
firstLineinteger

The part's first line.

At least 1
lastLineinteger

The part's last line.

At least 1
totalobject or null

The total Werk read in the document, or null when it found none.

Show properties of totalHide properties of total
valuestring

The total as read, a decimal number with a point.

Up to 128 characters
sourceobject

The part of the document it was read from.

Show properties of sourceHide properties of source
documentIdstring

The document's id.

At least 1 character
revisioninteger

The revision it was read in.

At least 1
pageinteger

The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.

At least 1
sha256string

The SHA-256 of the file it was read from.

locationobject

Where in the file the part is.

Show properties of locationHide properties of location

One of 5 shapes, told apart by kind:

kindpdf_page
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuespdf_page
pageinteger

The PDF page.

At least 1
kindsection
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessection
sectioninteger

The section, counted from 1.

At least 1
kindparagraph
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuesparagraph
paragraphinteger

The paragraph, counted from 1.

At least 1
kindsheet_rows
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessheet_rows
sheetstring

The sheet's name.

At least 1 character
firstRowinteger

The part's first row.

At least 1
lastRowinteger

The part's last row.

At least 1
kindlines
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valueslines
firstLineinteger

The part's first line.

At least 1
lastLineinteger

The part's last line.

At least 1
currencyobject or null

The currency Werk read in the document, or null when it found none.

Show properties of currencyHide properties of currency
valuestring

The currency as read, its ISO 4217 code.

sourceobject

The part of the document it was read from.

Show properties of sourceHide properties of source
documentIdstring

The document's id.

At least 1 character
revisioninteger

The revision it was read in.

At least 1
pageinteger

The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.

At least 1
sha256string

The SHA-256 of the file it was read from.

locationobject

Where in the file the part is.

Show properties of locationHide properties of location

One of 5 shapes, told apart by kind:

kindpdf_page
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuespdf_page
pageinteger

The PDF page.

At least 1
kindsection
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessection
sectioninteger

The section, counted from 1.

At least 1
kindparagraph
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuesparagraph
paragraphinteger

The paragraph, counted from 1.

At least 1
kindsheet_rows
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valuessheet_rows
sheetstring

The sheet's name.

At least 1 character
firstRowinteger

The part's first row.

At least 1
lastRowinteger

The part's last row.

At least 1
kindlines
kindenum

Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.

Allowed valueslines
firstLineinteger

The part's first line.

At least 1
lastLineinteger

The part's last line.

At least 1
failureCodeenum or null

Why reading failed, or null.

Allowed valuesparse_failedencryptedunsupported_formattranscription_failedsummary_failedinvalid_outputaccess_lostlimit_exceededprovider_unavailable
unitsinteger or null

What reading the document counts on the plan, in messages, or null before Werk inspected it.

At least 1
pagesinteger or null

A PDF's pages, or other text in pages of 3,000 characters; null when not known.

At least 1
sheetsinteger or null

A workbook's sheets with data; null for other files or when not known.

At least 1
removableboolean

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

hasMoreboolean

True when the card has more documents.

itemobject

The card.

Show properties of itemHide properties of item
outcomeenum

completed when the card is on its project's last step, not_completed when it was archived before it, open otherwise.

Allowed valuesopencompletednot_completed
idstring, uuid

The card's id.

refstring or null

The card's number as people write it, with # before it.

titlestring

The card's title, as written.

languagestring or null

The language the card's title and description are written in.

titleTranslationobject

The title in the reader's language, when it is written in another.

Show properties of titleTranslationHide properties of titleTranslation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

statusobject

The step the card is on, with where that step sits in the work.

Show properties of statusHide properties of status
keystring

The id of the step the card is on.

At least 1 character
labelstring

The step's name.

At least 1 character
categoryenum

open on a new step, done on the project's last step, active on any other step.

Allowed valuesopenactivedone
bucketenum

The kind of step the card is on; a step that ends the work reads in_progress while it is not the project's last step.

Allowed valuesnewin_progresswaitingresolvedclosed
labelLanguagestring

The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.

From 2 to 64 characters
labelTranslationobject

The step's name in the reader's language, when it is written in another.

Show properties of labelTranslationHide properties of labelTranslation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

dueNoticeLeadenum

How long before the due date its holder and followers get the due notice; none sends no notice.

Allowed valuesnoneat_due15_minutes1_hour2_hours1_day2_days
dueSetByobject or null

Who set the due moment; present only for a due date with a time.

Show properties of dueSetByHide properties of dueSetBy
displayNamestring

That person's name.

dueobject or null

The card's due date, or null when it has none.

Show properties of dueHide properties of due

One of 2 shapes, told apart by kind:

kinddate
kindenum

date for a due day with no time, datetime for a due moment.

Allowed valuesdate
datestring, date

The due day, as YYYY-MM-DD.

kinddatetime
kindenum

date for a due day with no time, datetime for a due moment.

Allowed valuesdatetime
atstring, date-time

The due moment, as an ISO 8601 date and time with its offset.

enteredTimeZonestring or null

The time zone the due moment was given in, when known.

assigneeobject or null

The card's holder, or null when the card is free.

Show properties of assigneeHide properties of assignee
personIdstring, uuid

The holder's person id.

displayNamestring

The holder's name as the project shows it.

initialsstring

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

photoobject

The holder'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
versioninteger

The card's version, which grows with every change to it.

At least 1
numberinteger or null

The card's number in its project, unique there and never reused.

At least 1
currentStepobject or null

The card's step among its project's steps, as the project defines it.

Show properties of currentStepHide properties of currentStep
idstring

The step's id; a change of step sends it as stepId.

At least 1 character
labelstring

The step's name.

At least 1 character
bucketenum

The kind of step: new for an open step, in_progress or waiting for one in between, resolved or closed for one that ends the work.

Allowed valuesnewin_progresswaitingresolvedclosed
labelLanguagestring

The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.

From 2 to 64 characters
labelTranslationobject

The step's name in the reader's language, when it is written in another.

Show properties of labelTranslationHide properties of labelTranslation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

archivedboolean

True when the card is archived: it has left the working lists and stays readable and searchable.

countsobject

How much the card holds.

Show properties of countsHide properties of counts
photosinteger

Photos on the card.

At least 0
updatesinteger

Updates on the card.

At least 0
documentsinteger

Documents on the card.

At least 0
checklistobject

The card's list: its items checked and in all; absent when the card has no list.

Show properties of checklistHide properties of checklist
doneinteger

List items checked.

At least 0
totalinteger

List items in all.

At least 0
allowedActionsarray of enums

The changes the key's person may make to this card by hand now, by action name.

Allowed valuestake_cardassign_cardgive_back_cardmove_cardarchive_cardunarchive_cardedit_cardset_card_dueadd_updatecreate_reminderlink_duplicateadd_entriesrename_entryremove_entryreorder_entriesfollow_cardunfollow_cardfollow_invitationtick_entryuntick_entryset_due_notice
descriptionstring or null

The card's description, or null when it has none.

descriptionTranslationobject

The description in the reader's language, when it is written in another.

Show properties of descriptionTranslationHide properties of descriptionTranslation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

authorobject or null

Who created the card, or null when no longer known.

Show properties of authorHide properties of author

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
createdAtstring, date-time

When the card was created.

assignedByobject or null

Who gave the card to its current holder, or null when that is not known.

Show properties of assignedByHide properties of assignedBy

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
photosobject

The card's photos, newest first, one page.

Show properties of photosHide properties 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
updatesobject

The card's updates, newest first, one page.

Show properties of updatesHide properties of updates
entriesarray of objects

The updates on this page, newest first.

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

The update's id.

authorobject or null

Who wrote the update, or null when no longer known.

Show properties of authorHide properties of author

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
createdAtstring, date-time

When the update was written.

entriesarray of objects

What the update holds: its notes, each with its photos.

From 1 to 50 items
Show properties of entriesHide properties of entries
idstring, uuid

The entry's id.

photosobject

The entry's photos.

Show properties of photosHide properties of photos
entriesarray of objects

The photos on this page, newest first.

Up to 10 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
textstring

The note's text, as written; empty when the entry holds photos alone.

languagestring or null

The language the note is written in.

translationobject

The note in the reader's language, when it is written in another.

Show properties of translationHide properties of translation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

createdAtstring, date-time

When the entry was written.

entriesPartialboolean

True when the update holds more entries than this page shows.

hasMoreboolean

True when older updates remain past this page.

nextCursorstring or null

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

From 1 to 512 characters
historyobject

The card's history, newest first, one page: every change, who made it and when.

Show properties of historyHide properties of history
entriesarray of objects

The history's entries on this page, newest first.

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

The entry's id.

createdAtstring, date-time

When the change was made.

actorobject or null

Who made the change, or null when no longer known.

Show properties of actorHide properties of actor

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
labelstring

The change in one line, a step named as the project wrote it.

At least 1 character
labelTranslationobject

The line in the reader's language, a step named by its translation.

Show properties of labelTranslationHide properties of labelTranslation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

hasMoreboolean

True when older entries remain past this page.

nextCursorstring or null

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

From 1 to 512 characters
duplicatesobject

How this card is joined to others as a duplicate.

Show properties of duplicatesHide properties of duplicates
ofobject or null

The card this one was marked a duplicate of, or null.

Show properties of ofHide properties of of
itemIdstring, uuid

That card's id.

numberinteger

That card's number.

At least 1
titlestring

That card's title.

statusstring

The name of the step that card is on.

joinedarray of objects

The cards marked duplicates of this one.

Show properties of joinedHide properties of joined
itemIdstring, uuid

That card's id.

numberinteger

That card's number.

At least 1
titlestring

That card's title.

statusstring

The name of the step that card is on.

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.
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_profile_changedThe project's setup changed while the cards were read.
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" \
  -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", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "followers": [
    {
      "kind": "user",
      "displayName": "Tom Okafor",
      "initials": "TO",
      "isViewer": false
    },
    {
      "kind": "user",
      "displayName": "Maya Chen",
      "initials": "MC",
      "isViewer": true
    }
  ],
  "following": true,
  "checklist": {
    "revision": 3,
    "batches": [
      {
        "id": "c6a0e4b8-9d3f-4ab5-87e9-5b1d3f8a2c40",
        "itemId": "1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81",
        "authorId": "8a2e6c14-3f5d-4b9a-a7e2-61c0d9f4b3e8",
        "createdAt": "2026-11-19T16:10:00.000Z",
        "groupId": "d7b1f5c9-0e4a-4bc6-98fa-6c2e4a9b3d51"
      }
    ],
    "items": [
      {
        "id": "a4e8c2f6-7b1d-4e93-a5c7-3f9b1d6e0a28",
        "position": 0,
        "batch": "c6a0e4b8-9d3f-4ab5-87e9-5b1d3f8a2c40",
        "text": "Shut off the water under the sink",
        "checked": true,
        "checkedAt": "2026-11-19T16:20:00.000Z",
        "checkedBy": {
          "kind": "user",
          "displayName": "Tom Okafor",
          "initials": "TO",
          "isViewer": false
        }
      },
      {
        "id": "b5f9d3a7-8c2e-4fa4-b6d8-4a0c2e7f1b39",
        "position": 1,
        "batch": "c6a0e4b8-9d3f-4ab5-87e9-5b1d3f8a2c40",
        "text": "Pick up the new cartridge",
        "checked": false,
        "checkedAt": null,
        "checkedBy": null
      }
    ],
    "counts": {
      "done": 1,
      "total": 2
    }
  },
  "item": {
    "outcome": "open",
    "id": "1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81",
    "ref": "#12",
    "title": "Replace the leaking sink faucet",
    "language": "en-US",
    "status": {
      "key": "waiting_parts",
      "label": "Waiting for parts",
      "category": "active",
      "bucket": "waiting"
    },
    "dueNoticeLead": "at_due",
    "due": null,
    "assignee": {
      "personId": "8a2e6c14-3f5d-4b9a-a7e2-61c0d9f4b3e8",
      "displayName": "Tom Okafor",
      "initials": "TO"
    },
    "version": 4,
    "number": 12,
    "currentStep": {
      "id": "waiting_parts",
      "label": "Waiting for parts",
      "bucket": "waiting"
    },
    "archived": false,
    "counts": {
      "photos": 1,
      "updates": 1,
      "documents": 0,
      "checklist": {
        "done": 1,
        "total": 2
      }
    }
  },
  "description": "The kitchen faucet drips from its base. The replacement cartridge is on order.",
  "author": {
    "kind": "user",
    "displayName": "Maya Chen",
    "initials": "MC",
    "isViewer": true
  },
  "createdAt": "2026-11-18T12:30:00.000Z",
  "assignedBy": {
    "kind": "user",
    "displayName": "Maya Chen",
    "initials": "MC",
    "isViewer": true
  },
  "photos": {
    "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
  },
  "updates": {
    "entries": [
      {
        "id": "c9a3e7f1-4d6b-4f80-a2c8-5b1e9d3f7a46",
        "author": {
          "kind": "user",
          "displayName": "Tom Okafor",
          "initials": "TO",
          "isViewer": false
        },
        "createdAt": "2026-11-19T16:12:00.000Z",
        "entries": [
          {
            "id": "e5b9d3a7-2f8c-4b14-9e6a-7c0f2d4b8e33",
            "photos": {
              "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
            },
            "text": "The base is cracked, so the whole faucet goes. Parts ordered.",
            "language": "en-US",
            "createdAt": "2026-11-19T16:12:00.000Z"
          }
        ],
        "entriesPartial": false
      }
    ],
    "hasMore": false,
    "nextCursor": null
  },
  "history": {
    "entries": [
      {
        "id": "f6c0e4b8-3a9d-4c25-8f1b-6d2a0e5c9f47",
        "createdAt": "2026-11-19T16:15:00.000Z",
        "actor": {
          "kind": "user",
          "displayName": "Tom Okafor",
          "initials": "TO",
          "isViewer": false
        },
        "label": "Tom Okafor moved it to Waiting for parts"
      }
    ],
    "hasMore": false,
    "nextCursor": null
  },
  "duplicates": {
    "of": null,
    "joined": []
  }
}