---
title: "List all period settings."
method: GET
path: "/api/periods/{periodId}/settings"
tags: ["Periods"]
---

# List all period settings.

`GET /api/periods/{periodId}/settings`

## Path parameters

- `periodId` string, required

## Response `200`

All period settings

- PeriodSetting[]
  - `_id` string, required
  - `period` Period, required
    - `_id` string, required
    - `name` string, required
    - `status` 'OPEN' | 'QUANTIFY' | 'CLOSED', required
    - `startDate` string, date-time, required
    - `endDate` string, date-time, required
    - `attestationsTxHash` string
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `setting` Setting, required
    - `_id` string, required
    - `key` string, required
    - `value` string, required
    - `valueRealized` union, required
      - string
      - string[]
      - boolean
      - number
      - number[]
    - `defaultValue` string, required
    - `type` 'Integer' | 'Float' | 'String' | 'Textarea' | 'Boolean' | 'IntegerList' | 'StringList' | 'Image' | 'Radio' | 'JSON', required
    - `label` string, required
    - `description` string, required
    - `group` number, required
    - `options` string, required
    - `subgroup` number, required
    - `periodOverridable` boolean, required
  - `value` string, required
  - `valueRealized` union, required
    - string
    - string[]
    - boolean
    - number
    - number[]

---

[API](https://skmtc.net/givepraise/apis/praise-api.md) · [All operations](https://skmtc.net/givepraise/apis/praise-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/givepraise/praise-api/versions/d960746392e5/schema)