Settings API

List settings

List workspace and current-member settings.

GET/v1/settings

capability settings.list · v1operational dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

scope"workspace" | "member"
query

Response

Successful responses use Dawn's data envelope.

dataSettingListrequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- createdAtstring<date-time>required
- updatedAtstring<date-time>required
- scope"workspace"required
- memberIdnullrequired
- key"workspace.name"required
- valuestringrequired
  min length 1max length 120
metaobject

Errors

Error responses use the shared error envelope.

422The setting query is invalid.
503Settings are temporarily unavailable.

Request

import { createDawnClient } from "@dawn/api";

const dawn = createDawnClient({
  baseUrl: "http://localhost:6400",
});

const result = await dawn.capabilities["settings.list"]({
  "scope": "workspace",
});

if (result.isErr()) throw result.error;
console.log(result.value);

Response

Successful response.

{
  "data": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "workspaceId": "22222222-2222-4222-8222-222222222222",
      "createdAt": "2026-08-01T09:00:00.000Z",
      "updatedAt": "2026-08-01T09:00:00.000Z",
      "scope": "workspace",
      "memberId": null,
      "key": "workspace.name",
      "value": "Circle Berlin"
    }
  ],
  "meta": {}
}