Get a card by id
A card whole, found by its id in whichever of the key's person's projects holds it.
The same card as the project's own route gives, with its project's id beside it.
Authorization
Authorization: Bearer <key> Authentication
Headers
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
The card's id.
Query parameters
How many of the card's photos the answer holds.
The photos' nextCursor from an earlier answer, to read older photos.
How many of the card's updates the answer holds.
The updates' nextCursor from an earlier answer, to read older updates.
How many history entries the answer holds.
The history's nextCursor from an earlier answer, to read older entries.
Response
200 The card and its project.
The card's project.
The id Werk's apps use for the key's person's view of the project.
The card in full.
Show properties of itemHide properties of item
The people who follow the card.
Show properties of followersHide properties of followers
One of 3 shapes, told apart by kind:
kinduseruser for a person; connector or schedule for a change Werk made without one.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
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
connection for an app connected by sign-in, key for an API key.
The app's or the key's name, as Werk shows it.
True when Werk verified the app's identity.
The caption Werk shows beside the change, in the reader's language.
kindconnectoruser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
kindscheduleuser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
True when the key's person follows the card.
The card's list of items to check off.
Show properties of checklistHide properties of checklist
The list's revision, which grows with every change to it; a change to the list sends it as expectedRevision.
The sets of items added together in one change.
Show properties of batchesHide properties of batches
The set's id, which each of its items names as batch.
The card's id.
The person who added the set, or null when no person did.
When the set was added.
The id of the change that added the set.
The list's items, in their order.
Show properties of itemsHide properties of items
The item's id.
The item's place in the list, from 0.
The id of the set the item was added in, or null when it was added on its own.
The item's text, as written.
The text in the reader's language, when it is written in another.
Show properties of translationHide properties of translation
The reader's language the text is translated into.
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.
The translated text, present once ready.
True when the item is checked.
When the item was checked, or null while it is not.
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:
kinduseruser for a person; connector or schedule for a change Werk made without one.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
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
connection for an app connected by sign-in, key for an API key.
The app's or the key's name, as Werk shows it.
True when Werk verified the app's identity.
The caption Werk shows beside the change, in the reader's language.
kindconnectoruser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
kindscheduleuser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
The list's items checked and in all.
Show properties of countsHide properties of counts
List items checked.
List items in all.
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
The next three upcoming reminders, soonest first.
Show properties of remindersHide properties of reminders
The reminder's id.
The card the reminder is on.
The reminder's version, which grows with every change to it; a change sends it as expectedVersion.
Grows each time the reminder's time changes; a change sends it as expectedTimeRevision.
Grows each time the key's person snoozes the reminder; a change sends it as expectedSnoozeRevision.
The time its owner set the reminder for.
When the reminder goes off for the key's person: the snoozed time, else the set time.
The time the key's person snoozed the reminder to, or null.
The time zone the reminder's time was set in.
The reminder's text, as its owner wrote it.
The language a shared reminder's text is written in.
A shared reminder's text in the reader's language, when it is written in another.
Show properties of translationHide properties of translation
The reader's language the text is translated into.
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.
The translated text, present once ready.
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.
Whose reminder it is and who it is shared with.
Show properties of audienceHide properties of audience
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.
Who the reminder is for, in one line in the reader's language.
The person who set the reminder.
Show properties of ownerHide properties of owner
The person's id.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The people the owner shared the reminder with who accepted it.
Show properties of invitedHide properties of invited
The person's id.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
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
The reminder's id.
The reminder's version as last read.
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.
How many reminders there are in all, past and dropped ones included.
The documents on the card.
Show properties of documentsHide properties of documents
The card's first three documents.
Show properties of documentsHide properties of documents
The document's id.
The card the document is on.
The document's name.
The document's media type.
The document's revision, which grows each time its file is replaced.
not_read while it is not being read, awaiting_confirmation while Werk waits for a yes to its cost, reading, failed, or ready.
The document's version, which grows with every change to it; a read request sends it as expectedVersion.
How many parts the document has, or null while not known.
How many parts Werk read.
True when Werk read only the document's first parts.
Werk's summary of the document, or null.
The issuer, number, date, total and currency Werk read in the document, or null.
Show properties of fieldsHide properties of fields
The issuer Werk read in the document, or null when it found none.
Show properties of issuerHide properties of issuer
The issuer as read.
The part of the document it was read from.
Show properties of sourceHide properties of source
The document's id.
The revision it was read in.
The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.
The SHA-256 of the file it was read from.
Where in the file the part is.
Show properties of locationHide properties of location
One of 5 shapes, told apart by kind:
kindpdf_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The PDF page.
kindsectionWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The section, counted from 1.
kindparagraphWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The paragraph, counted from 1.
kindsheet_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The sheet's name.
The part's first row.
The part's last row.
kindlinesWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The part's first line.
The part's last line.
The document's number Werk read in the document, or null when it found none.
Show properties of numberHide properties of number
The document's number as read.
The part of the document it was read from.
Show properties of sourceHide properties of source
The document's id.
The revision it was read in.
The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.
The SHA-256 of the file it was read from.
Where in the file the part is.
Show properties of locationHide properties of location
One of 5 shapes, told apart by kind:
kindpdf_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The PDF page.
kindsectionWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The section, counted from 1.
kindparagraphWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The paragraph, counted from 1.
kindsheet_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The sheet's name.
The part's first row.
The part's last row.
kindlinesWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The part's first line.
The part's last line.
The date Werk read in the document, or null when it found none.
Show properties of dateHide properties of date
The date as read, as YYYY-MM-DD.
The part of the document it was read from.
Show properties of sourceHide properties of source
The document's id.
The revision it was read in.
The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.
The SHA-256 of the file it was read from.
Where in the file the part is.
Show properties of locationHide properties of location
One of 5 shapes, told apart by kind:
kindpdf_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The PDF page.
kindsectionWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The section, counted from 1.
kindparagraphWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The paragraph, counted from 1.
kindsheet_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The sheet's name.
The part's first row.
The part's last row.
kindlinesWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The part's first line.
The part's last line.
The total Werk read in the document, or null when it found none.
Show properties of totalHide properties of total
The total as read, a decimal number with a point.
The part of the document it was read from.
Show properties of sourceHide properties of source
The document's id.
The revision it was read in.
The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.
The SHA-256 of the file it was read from.
Where in the file the part is.
Show properties of locationHide properties of location
One of 5 shapes, told apart by kind:
kindpdf_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The PDF page.
kindsectionWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The section, counted from 1.
kindparagraphWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The paragraph, counted from 1.
kindsheet_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The sheet's name.
The part's first row.
The part's last row.
kindlinesWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The part's first line.
The part's last line.
The currency Werk read in the document, or null when it found none.
Show properties of currencyHide properties of currency
The currency as read, its ISO 4217 code.
The part of the document it was read from.
Show properties of sourceHide properties of source
The document's id.
The revision it was read in.
The part, counted from 1 in Werk's own count; only a PDF page's location names a page of the file.
The SHA-256 of the file it was read from.
Where in the file the part is.
Show properties of locationHide properties of location
One of 5 shapes, told apart by kind:
kindpdf_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The PDF page.
kindsectionWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The section, counted from 1.
kindparagraphWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The paragraph, counted from 1.
kindsheet_Where in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The sheet's name.
The part's first row.
The part's last row.
kindlinesWhere in the file the part is: a PDF page, a section, a paragraph, a sheet's rows or a text's lines.
The part's first line.
The part's last line.
Why reading failed, or null.
What reading the document counts on the plan, in messages, or null before Werk inspected it.
A PDF's pages, or other text in pages of 3,000 characters; null when not known.
A workbook's sheets with data; null for other files or when not known.
True when the key's person may take this document off the card now.
True when the card has more documents.
The card.
Show properties of itemHide properties of item
completed when the card is on its project's last step, not_completed when it was archived before it, open otherwise.
The card's id.
The card's number as people write it, with # before it.
The card's title, as written.
The language the card's title and description are written in.
The title in the reader's language, when it is written in another.
Show properties of titleTranslationHide properties of titleTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
The step the card is on, with where that step sits in the work.
Show properties of statusHide properties of status
The id of the step the card is on.
The step's name.
open on a new step, done on the project's last step, active on any other step.
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.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
How long before the due date its holder and followers get the due notice; none sends no notice.
Who set the due moment; present only for a due date with a time.
Show properties of dueSetByHide properties of dueSetBy
That person's name.
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:
kinddatedate for a due day with no time, datetime for a due moment.
The due day, as YYYY-MM-DD.
kinddatetimedate for a due day with no time, datetime for a due moment.
The due moment, as an ISO 8601 date and time with its offset.
The time zone the due moment was given in, when known.
The card's holder, or null when the card is free.
Show properties of assigneeHide properties of assignee
The holder's person id.
The holder's name as the project shows it.
The holder's initials, for an avatar with no photo.
The holder's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The card's version, which grows with every change to it.
The card's number in its project, unique there and never reused.
The card's step among its project's steps, as the project defines it.
Show properties of currentStepHide properties of currentStep
The step's id; a change of step sends it as stepId.
The step's name.
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.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
True when the card is archived: it has left the working lists and stays readable and searchable.
How much the card holds.
Show properties of countsHide properties of counts
Photos on the card.
Updates on the card.
Documents on the card.
The card's list: its items checked and in all; absent when the card has no list.
Show properties of checklistHide properties of checklist
List items checked.
List items in all.
The changes the key's person may make to this card by hand now, by action name.
The card's description, or null when it has none.
The description in the reader's language, when it is written in another.
Show properties of descriptionTranslationHide properties of descriptionTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
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:
kinduseruser for a person; connector or schedule for a change Werk made without one.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
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
connection for an app connected by sign-in, key for an API key.
The app's or the key's name, as Werk shows it.
True when Werk verified the app's identity.
The caption Werk shows beside the change, in the reader's language.
kindconnectoruser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
kindscheduleuser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
When the card was created.
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:
kinduseruser for a person; connector or schedule for a change Werk made without one.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
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
connection for an app connected by sign-in, key for an API key.
The app's or the key's name, as Werk shows it.
True when Werk verified the app's identity.
The caption Werk shows beside the change, in the reader's language.
kindconnectoruser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
kindscheduleuser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
The card's photos, newest first, one page.
Show properties of photosHide properties of photos
The photos on this page, newest first.
Show properties of entriesHide properties of entries
The photo's id on the card; removing it names this id.
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:
kinduseruser for a person; connector or schedule for a change Werk made without one.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
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
connection for an app connected by sign-in, key for an API key.
The app's or the key's name, as Werk shows it.
True when Werk verified the app's identity.
The caption Werk shows beside the change, in the reader's language.
kindconnectoruser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
kindscheduleuser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
The photo's file.
Show properties of assetHide properties of asset
The file's id.
What the file is: a photo, a voice recording or a document.
The document's name; only a document has one.
The document's format; only a document has one.
The file's media type.
The file's size in bytes.
The photo's width in pixels; absent on photos stored before sizes were kept.
The photo's height in pixels; absent on photos stored before sizes were kept.
The recording's length in seconds; only a voice recording has one.
False once the file's bytes were released and it can no longer be read.
When the photo was added to the card.
True when the key's person may take this photo off the card now.
True when older photos remain past this page.
The cursor that reads the next page, or null when none remains.
The card's updates, newest first, one page.
Show properties of updatesHide properties of updates
The updates on this page, newest first.
Show properties of entriesHide properties of entries
The update's id.
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:
kinduseruser for a person; connector or schedule for a change Werk made without one.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
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
connection for an app connected by sign-in, key for an API key.
The app's or the key's name, as Werk shows it.
True when Werk verified the app's identity.
The caption Werk shows beside the change, in the reader's language.
kindconnectoruser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
kindscheduleuser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
When the update was written.
What the update holds: its notes, each with its photos.
Show properties of entriesHide properties of entries
The entry's id.
The entry's photos.
Show properties of photosHide properties of photos
The photos on this page, newest first.
Show properties of entriesHide properties of entries
The photo's id on the card; removing it names this id.
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:
kinduseruser for a person; connector or schedule for a change Werk made without one.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
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
connection for an app connected by sign-in, key for an API key.
The app's or the key's name, as Werk shows it.
True when Werk verified the app's identity.
The caption Werk shows beside the change, in the reader's language.
kindconnectoruser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
kindscheduleuser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
The photo's file.
Show properties of assetHide properties of asset
The file's id.
What the file is: a photo, a voice recording or a document.
The document's name; only a document has one.
The document's format; only a document has one.
The file's media type.
The file's size in bytes.
The photo's width in pixels; absent on photos stored before sizes were kept.
The photo's height in pixels; absent on photos stored before sizes were kept.
The recording's length in seconds; only a voice recording has one.
False once the file's bytes were released and it can no longer be read.
When the photo was added to the card.
True when the key's person may take this photo off the card now.
True when older photos remain past this page.
The cursor that reads the next page, or null when none remains.
The note's text, as written; empty when the entry holds photos alone.
The language the note is written in.
The note in the reader's language, when it is written in another.
Show properties of translationHide properties of translation
The reader's language the text is translated into.
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.
The translated text, present once ready.
When the entry was written.
True when the update holds more entries than this page shows.
True when older updates remain past this page.
The cursor that reads the next page, or null when none remains.
The card's history, newest first, one page: every change, who made it and when.
Show properties of historyHide properties of history
The history's entries on this page, newest first.
Show properties of entriesHide properties of entries
The entry's id.
When the change was made.
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:
kinduseruser for a person; connector or schedule for a change Werk made without one.
The person's name as the project shows it.
The person's initials, for an avatar with no photo.
True when the person is the key's own person.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
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
connection for an app connected by sign-in, key for an API key.
The app's or the key's name, as Werk shows it.
True when Werk verified the app's identity.
The caption Werk shows beside the change, in the reader's language.
kindconnectoruser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
kindscheduleuser for a person; connector or schedule for a change Werk made without one.
The name Werk shows for a change made without a person.
The change in one line, a step named as the project wrote it.
The line in the reader's language, a step named by its translation.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
True when older entries remain past this page.
The cursor that reads the next page as historyBefore, or null when none remains.
How this card is joined to others as a duplicate.
Show properties of duplicatesHide properties of duplicates
The card this one was marked a duplicate of, or null.
Show properties of ofHide properties of of
That card's id.
That card's number.
That card's title.
The name of the step that card is on.
The cards marked duplicates of this one.
Show properties of joinedHide properties of joined
That card's id.
That card's number.
That card's title.
The name of the step that card is on.
Errors
invalid_query The 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).invalid_cursor The page cursor is not one this list gave.session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.project_not_permitted The signed-in person's role in the project does not allow this request on the project.item_not_found The card the request names, or its list, is not one the signed-in person can see.session_changed The session changed while the request was in flight.cursor_expired The page cursor no longer fits the list as it stands or the arguments it was read with.project_profile_changed The project's setup changed while the cards were read.rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.server_error The server could not complete the request, and it is not known whether a write it holds was made.curl "https://api.getwerk.ai/api/v1/cards/1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81" \
-H "Authorization: Bearer wk_key_..."const res = await fetch("https://api.getwerk.ai/api/v1/cards/1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81", {
headers: {
Authorization: "Bearer wk_key_...",
},
});
const answer = await res.json();{
"projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
"conversationId": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
"item": {
"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": []
}
}
}Send a requestGET
It is sent with the key you give, as you. A change made here is real.
The request could not be sent, or its response could not be read.