Search cards
The key's person's cards across their projects, listed by filters or searched by words.
With q, Werk looks in the cards' titles, descriptions, updates, lists, photos, voice notes and documents, by words and by meaning, best match first. Without q, the cards the filters keep are listed in the order sort and order give, each with its own default.
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.
Query parameters
The words to look for; left out, cards are listed by the other filters.
Where to look for the words, comma separated: title, description, card, update, list, photo, voice_note, document; left out, everywhere.
Project ids, comma separated; left out, every project of the key's person.
open, done, archived or all; left out, all with q or a span of when cards were made, changed or done, and open otherwise.
A person's id to keep the cards they hold, or none for free cards.
A person's id, to keep the cards they created.
true keeps the cards the key's person follows.
A step's id, to keep the cards on it; only with exactly one project in projects.
none keeps the cards with no due date; it cannot go with dueFrom or dueBefore.
Keeps cards due from this day or moment on: YYYY-MM-DD in the key's person's time zone, or an ISO 8601 date and time with Z or an offset.
Keeps cards due before this day or moment, in the same forms as dueFrom.
Keeps cards created from this day or moment on, in the same forms as dueFrom.
Keeps cards created before this day or moment.
Keeps cards changed from this day or moment on.
Keeps cards changed before this day or moment.
Keeps cards that reached their last step from this day or moment on.
Keeps cards that reached their last step before this day or moment.
relevance, only with q; board, the project's own order, with exactly one project and a state other than all; updated, created, due or number. Left out, relevance with q, board for one project, updated otherwise.
The order of the sort; left out, each sort's own: oldest first for board, due and number, newest first for the rest.
How many cards a page holds.
The cursor from the previous page's nextCursor; left out, the first page.
Response
200 The cards found.
The cards found, in the order asked.
Show properties of itemsHide properties of items
The card's project.
Show properties of projectHide properties of project
The project's id.
The id Werk's apps use for the key's person's view of the project.
The project's name.
The project's last step, the one that ends the work.
Show properties of finalStepHide properties of finalStep
The step's id.
The step's name.
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.
With words, how the card was found: by its words, by meaning, or both; empty without words.
With words, where on the card they matched.
Show properties of matchesHide properties of matches
One of 6 shapes, told apart by in:
intitleWhere it matched: the title, the description, the card's text by meaning, an update, a list item, a photo, a voice note or a document.
incardWhere it matched: the title, the description, the card's text by meaning, an update, a list item, a photo, a voice note or a document.
indescriptionWhere it matched: the title, the description, the card's text by meaning, an update, a list item, a photo, a voice note or a document.
The piece of text that matched, or null when none is quoted.
inupdatephotovoice_Where it matched: the title, the description, the card's text by meaning, an update, a list item, a photo, a voice note or a document.
The piece of text that matched, or null when none is quoted.
Who added what matched, or null when no longer known.
Show properties of byHide properties of by
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 what matched was added.
inlistWhere it matched: the title, the description, the card's text by meaning, an update, a list item, a photo, a voice note or a document.
The piece of text that matched, or null when none is quoted.
Who added what matched, or null when no longer known.
Show properties of byHide properties of by
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 what matched was added.
For a list item, true when it is checked.
indocumentWhere it matched: the title, the description, the card's text by meaning, an update, a list item, a photo, a voice note or a document.
The piece of text that matched, or null when none is quoted.
Who added what matched, or null when no longer known.
Show properties of byHide properties of by
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 what matched was added.
For a document, which one and where.
Show properties of documentHide properties of document
The document's id.
The document's name.
The part of the document it matched in, counted from 1.
How many cards match in all, past this page included.
False when the search read as deep as it goes, so more cards may match than total says.
With words, true when the search also looked by meaning; null without words.
The cursor that reads the next page as after, or null when none remains.
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_card_query The request about cards or their files is not in the form its route takes, or names a day of a filter while the signed-in person's profile has no time zone; 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).session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.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?q=faucet" \
-H "Authorization: Bearer wk_key_..."const res = await fetch("https://api.getwerk.ai/api/v1/cards?q=faucet", {
headers: {
Authorization: "Bearer wk_key_...",
},
});
const answer = await res.json();{
"items": [
{
"project": {
"projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
"conversationId": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
"name": "Harbor Street kitchen",
"finalStep": {
"id": "paid",
"label": "Paid"
}
},
"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
}
},
"foundBy": [
"words"
],
"matches": [
{
"in": "title"
}
]
}
],
"total": 1,
"complete": true,
"byMeaning": true,
"nextCursor": null
}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.