Sign in
Periods

List all period settings.

get/api/periods/{periodId}/settings

Path parameters

periodIdstring required

Response

All period settings

_idstring required
valuestring required

Example response

[
  {
    "_id": "62291b7ea8b1619f78818524",
    "period": {
      "_id": "621f802b813dbdba9eeaf7d7",
      "name": "June 2021",
      "attestationsTxHash": "0x46164b8581258eec4b4f44d626925953d0d7581514d9fd1335e3bd660d48e07c"
    },
    "setting": {
      "_id": "621f802b813dbdbaddeaf799",
      "key": "SETTING_KEY",
      "value": "666",
      "defaultValue": "555",
      "label": "Quantifiers Per Praise",
      "description": "How many redundant quantifications are assigned to each praise?",
      "periodOverridable": true
    },
    "value": "666"
  }
]

Changes

Changed in 15 of the 50 revisions of this API.97

  • 89707aed2e4e1See the full diff
    • ▲

      the response property items/period/allOf[Period]/attestationsTxHash became optional for the status 200

      response-property-became-optional

  • 990e717b779e1See the full diff
    • ○

      endpoint added

      endpoint-added

  • abdaebb919d21See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 56 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 00d037b830a52See the full diff
    • ▲

      removed the required property items/period/allOf[Period]/attestationsTxHash from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property items/period/allOf[Period]/startDate from the response with the 200 status

      response-required-property-removed

  • a1650a3ffd3f1See the full diff
    • ○

      added the required property items/period/allOf[Period]/startDate to the response with the 200 status

      response-required-property-added

  • 0373dfbf63cd1See the full diff
    • ○

      added the required property items/period/allOf[Period]/attestationsTxHash to the response with the 200 status

      response-required-property-added

  • a856c86b76ec1See the full diff
    • ▲

      the items/value response property's maxLength was increased from 255 to 512 for the response status 200

      response-property-max-length-increased

  • e14b4c818c531See the full diff
    • ○

      endpoint added

      endpoint-added

  • e8ffc3233d9e1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 52 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • aa4804c758aa1See the full diff
    • ○

      endpoint added

      endpoint-added