Settings API

Get a setting

Get a workspace or current-member setting.

GET/v1/settings/{settingId}

capability settings.get · v1operational dataserver-scoped workspace

Request

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

settingIdstring<uuid>required
path

Response

Successful responses use Dawn's data envelope.

dataSettingrequired
- 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.

404The setting could not be found.
422The setting ID is invalid.
503The setting is temporarily unavailable.

Request

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

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

const result = await dawn.capabilities["settings.get"]({
  "settingId": settingIdSchema.parse("55555555-5555-4555-8555-555555555555"),
});

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": {}
}