List account changes
What changed in the key's person's projects since a cursor: their people, their list, their Pulse, their plan.
Each change names what to read again, never its content. An outside client has no way to get a first cursor today, so every call answers cursor_expired.
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 cursor of the last change read.
How many changes a page holds.
Response
200 The changes after the cursor.
The changes, oldest first.
Show properties of changesHide properties of changes
One of 6 shapes, told apart by kind:
kindproject_The change's cursor.
What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.
The project the change is about.
The project's people version after the change.
kindprojects_The change's cursor.
What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.
The project the change is about.
Grows with each change to the project, so an older change can be told from a newer one.
The projects' current state, for a change of the list or of the plan.
Show properties of projectStatusesHide properties of projectStatuses
The project's id.
The id Werk's apps use for the key's person's view of this project; the API's paths take projectId.
True when the project is archived.
The owner's name.
True when the key's person owns the project.
The key's person's role in the project.
The version of the project's settings (its name, steps and archive), which grows with each change to them; such a change sends it as expectedConfigVersion.
What the key's person may do with the project now.
Show properties of capabilitiesHide properties of capabilities
True when the key's person may invite people to the project.
True when they may manage the project's people.
True when they may make a person an admin or a member.
True when they may remove people from the project.
True when they may change the project's steps.
True when they may archive the project.
True when they may bring the project back from the archive.
True when they may delete the project.
True when they may hand the project to another person and leave it.
True when they may rename the project.
True when they may change the project's photo.
True when they may leave the project.
A project that left the key's person's list: they were removed from it, or it is being deleted.
True when only the key's person's own settings for the project changed, not its cards.
kindplan_The change's cursor.
What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.
The projects' current state, for a change of the list or of the plan.
Show properties of projectStatusesHide properties of projectStatuses
The project's id.
The id Werk's apps use for the key's person's view of this project; the API's paths take projectId.
True when the project is archived.
The owner's name.
True when the key's person owns the project.
The key's person's role in the project.
The version of the project's settings (its name, steps and archive), which grows with each change to them; such a change sends it as expectedConfigVersion.
What the key's person may do with the project now.
Show properties of capabilitiesHide properties of capabilities
True when the key's person may invite people to the project.
True when they may manage the project's people.
True when they may make a person an admin or a member.
True when they may remove people from the project.
True when they may change the project's steps.
True when they may archive the project.
True when they may bring the project back from the archive.
True when they may delete the project.
True when they may hand the project to another person and leave it.
True when they may rename the project.
True when they may change the project's photo.
True when they may leave the project.
kindfor_The change's cursor.
What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.
How many Pulse rows are unread now.
kindgoogle_The change's cursor.
What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.
kindlocale_The change's cursor.
What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.
The cursor to read the next changes from.
True when more changes wait past this page.
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_limit The page size, or the number of entries asked, is not one the list takes.session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.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.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/account/changes?after=YWNjb3VudDo0MjE&limit=50" \
-H "Authorization: Bearer wk_key_..."const res = await fetch("https://api.getwerk.ai/api/v1/account/changes?after=YWNjb3VudDo0MjE&limit=50", {
headers: {
Authorization: "Bearer wk_key_...",
},
});
const answer = await res.json();{
"changes": [
{
"cursor": "YWNjb3VudDo0MjI",
"kind": "project_people_changed",
"projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
"peopleVersion": 4
}
],
"cursor": "YWNjb3VudDo0MjI",
"hasMore": false
}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.