DevelopersHow to connect an assistantKeys
Reference/Profile/Read

List the settings

GEThttps://api.getwerk.ai/api/v1/settings

The key's person's own settings, each with its value and whether a key may change it.

An API key may change the translation of cards only; the rest are changed in Werk's apps.

Authorization

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Response

200 The settings.

levelenum

Whose settings these are: the account's or a project's.

Allowed valuespersonprojectproject_person
settingsarray of objects

Each setting with its value.

Show properties of settingsHide properties of settings
keyenum

The setting's name.

Allowed valuesbrief_timebrief_onbrief_resume_dateemail_due_noticesemail_own_remindersemail_invitationspush_my_cardspush_due_noticespush_own_reminderspush_invitationspush_project_peoplepush_from_werktranslate_cardstranslate_offercards_drawer_levelquiet_hours_onquiet_startquiet_endquiet_daysquiet_untildue_notice_leadcolorhighlightedmutedin_morning_brieftranslate_offer_closed
valueboolean or null

The setting's value.

versioninteger

The setting's version, which a change sends as expectedVersion; 0 for one never set.

At least 0
updatedAtstring, date-time or null

When it last changed, or null when never set.

canWriteboolean

True when the caller may change it.

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).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
404not_foundThe route or record the request names does not exist, or is not one the signed-in person can reach.
409session_changedThe session changed while the request was in flight.
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/settings" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/settings", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "level": "person",
  "settings": [
    {
      "key": "translate_cards",
      "value": true,
      "version": 1,
      "updatedAt": "2026-10-30T12:00:00.000Z",
      "canWrite": true
    }
  ]
}