---
title: "List all periods"
method: GET
path: "/api/periods"
tags: ["Periods"]
---

# List all periods

`GET /api/periods`

## Query parameters

- `limit` number, required
- `page` number, required
- `sortColumn` string
- `sortType` 'asc' | 'desc'

## Response `200`

Periods

- PeriodPaginatedResponseDto
  - `totalDocs` number, required
  - `limit` number, required
  - `totalPages` number, required
  - `page` number
  - `pagingCounter` number, required
  - `hasPrevPage` object, required
  - `hasNextPage` object, required
  - `prevPage` object
  - `nextPage` object
  - `docs` 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
  - `meta` object

## Changes

- **2023-09-22** `89707aed2e4e` — 1 breaking
  - the response property `docs/items/attestationsTxHash` became optional for the status `200`
- **2023-08-23** `990e717b779e` — 1 info
  - endpoint added
- **2023-08-23** `abdaebb919d2` — 1 breaking
  - api path removed without deprecation
- **2023-08-11** `00d037b830a5` — 2 breaking
  - removed the required property `docs/items/attestationsTxHash` from the response with the `200` status
  - removed the required property `docs/items/startDate` from the response with the `200` status
- **2023-08-06** `a1650a3ffd3f` — 1 info
  - added the required property `docs/items/startDate` to the response with the `200` status

[Full history](https://skmtc.dev/givepraise/apis/praise-api/changes/api/periods/get.md)

---

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