DevelopersHow to connect an assistantKeys
Reference/Projects/Read

List account changes

GEThttps://api.getwerk.ai/api/v1/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

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.

Query parameters

afterstringRequired

The cursor of the last change read.

At least 1 character
limitinteger

How many changes a page holds.

From 1 to 100
Default100

Response

200 The changes after the cursor.

changesarray of objects

The changes, oldest first.

Show properties of changesHide properties of changes

One of 6 shapes, told apart by kind:

kindproject_people_changed
cursorstring

The change's cursor.

From 1 to 512 characters
kindenum

What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.

Allowed valuesproject_people_changed
projectIdstring, uuid

The project the change is about.

peopleVersioninteger

The project's people version after the change.

At least 1
kindprojects_changed
cursorstring

The change's cursor.

From 1 to 512 characters
kindenum

What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.

Allowed valuesprojects_changed
projectIdstring, uuid

The project the change is about.

invalidationVersionstring

Grows with each change to the project, so an older change can be told from a newer one.

projectStatusesarray of objects

The projects' current state, for a change of the list or of the plan.

Show properties of projectStatusesHide properties of projectStatuses
projectIdstring, uuid

The project's id.

conversationIdstring, uuid

The id Werk's apps use for the key's person's view of this project; the API's paths take projectId.

archivedboolean

True when the project is archived.

ownerNamestring

The owner's name.

isOwnerboolean

True when the key's person owns the project.

viewerRoleenum

The key's person's role in the project.

Allowed valuesowneradminmembercollaborator
projectConfigVersioninteger

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.

At least 1
capabilitiesobject

What the key's person may do with the project now.

Show properties of capabilitiesHide properties of capabilities
inviteboolean

True when the key's person may invite people to the project.

managePeopleboolean

True when they may manage the project's people.

changeRolesboolean

True when they may make a person an admin or a member.

removePeopleboolean

True when they may remove people from the project.

editListsboolean

True when they may change the project's steps.

archiveboolean

True when they may archive the project.

restoreboolean

True when they may bring the project back from the archive.

deleteboolean

True when they may delete the project.

transferOwnershipboolean

True when they may hand the project to another person and leave it.

renameboolean

True when they may rename the project.

changePhotoboolean

True when they may change the project's photo.

leaveboolean

True when they may leave the project.

removedProjectIdstring, uuid

A project that left the key's person's list: they were removed from it, or it is being deleted.

rowOnlyenum

True when only the key's person's own settings for the project changed, not its cards.

Allowed valuestrue
kindplan_changed
cursorstring

The change's cursor.

From 1 to 512 characters
kindenum

What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.

Allowed valuesplan_changed
projectStatusesarray of objects

The projects' current state, for a change of the list or of the plan.

Show properties of projectStatusesHide properties of projectStatuses
projectIdstring, uuid

The project's id.

conversationIdstring, uuid

The id Werk's apps use for the key's person's view of this project; the API's paths take projectId.

archivedboolean

True when the project is archived.

ownerNamestring

The owner's name.

isOwnerboolean

True when the key's person owns the project.

viewerRoleenum

The key's person's role in the project.

Allowed valuesowneradminmembercollaborator
projectConfigVersioninteger

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.

At least 1
capabilitiesobject

What the key's person may do with the project now.

Show properties of capabilitiesHide properties of capabilities
inviteboolean

True when the key's person may invite people to the project.

managePeopleboolean

True when they may manage the project's people.

changeRolesboolean

True when they may make a person an admin or a member.

removePeopleboolean

True when they may remove people from the project.

editListsboolean

True when they may change the project's steps.

archiveboolean

True when they may archive the project.

restoreboolean

True when they may bring the project back from the archive.

deleteboolean

True when they may delete the project.

transferOwnershipboolean

True when they may hand the project to another person and leave it.

renameboolean

True when they may rename the project.

changePhotoboolean

True when they may change the project's photo.

leaveboolean

True when they may leave the project.

kindfor_you_changed
cursorstring

The change's cursor.

From 1 to 512 characters
kindenum

What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.

Allowed valuesfor_you_changed
unreadCountinteger

How many Pulse rows are unread now.

At least 0
kindgoogle_calendar_changed
cursorstring

The change's cursor.

From 1 to 512 characters
kindenum

What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.

Allowed valuesgoogle_calendar_changed
kindlocale_changed
cursorstring

The change's cursor.

From 1 to 512 characters
kindenum

What changed: a project's people, the project list, the plan, Pulse, the Google Calendar connection, or the language chosen.

Allowed valueslocale_changed
cursorstring

The cursor to read the next changes from.

hasMoreboolean

True when more changes wait past this page.

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_limitThe page size, or the number of entries asked, is not one the list takes.
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
409session_changedThe session changed while the request was in flight.
409cursor_expiredThe page cursor no longer fits the list as it stands or the arguments it was read with.
rate_limitedMore requests of this kind were sent than Werk takes within the time it counts them over.
500server_errorThe server could not complete the request, and it is not known whether a write it holds was made.
curl
curl "https://api.getwerk.ai/api/v1/account/changes?after=YWNjb3VudDo0MjE&limit=50" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
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();
200JSON
{
  "changes": [
    {
      "cursor": "YWNjb3VudDo0MjI",
      "kind": "project_people_changed",
      "projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
      "peopleVersion": 4
    }
  ],
  "cursor": "YWNjb3VudDo0MjI",
  "hasMore": false
}