> ## Documentation Index
> Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Time periods

> Manage time periods in Exsited: list, create, retrieve, update, enable, disable and delete them.

Time periods define a length of time, such as one month, in your Exsited settings. You can list, create, retrieve, update and delete them, and enable or disable one through its `status`. This area has 5 endpoints, each available in all seven SDKs.

> [!WARNING]
>
> **Deleting a time period cannot be undone.** After a delete, reading the time period returns `404`.

## At a glance

| Endpoint | Method | Path | What it does |
| - | - | - | - |
| [List time periods](https://exsited.mintlify.site/api-reference/time-periods/list-time-periods.md) | GET | `/settings/time_periods` | Lists the time periods set up in Exsited, one page at a time. |
| [Create a time period](https://exsited.mintlify.site/api-reference/time-periods/create-a-time-period.md) | POST | `/settings/time_periods` | Creates a time period, such as one month, and returns it under `time_period`. |
| [Retrieve a time period](https://exsited.mintlify.site/api-reference/time-periods/retrieve-a-time-period.md) | GET | `/settings/time_periods/{time_period_id}` | Retrieves one time period by its `tp_` id. |
| [Delete a time period](https://exsited.mintlify.site/api-reference/time-periods/delete-a-time-period.md) | DELETE | `/settings/time_periods/{time_period_id}` | Deletes a time period; the response has no body. |
| [Update a time period](https://exsited.mintlify.site/api-reference/time-periods/update-a-time-period.md) | PATCH | `/settings/time_periods/{time_period_id}` | Updates a time period's details, or enables or disables it. |

## Before you call

Register your API credentials once when your app starts, as shown in
[Authentication](https://exsited.mintlify.site/authentication.md). Every SDK sample on these pages then gets its client in one line.
With cURL, send the access token in an `Authorization` header: `Authorization: Bearer $ACCESS_TOKEN`.

## Things to know

* **Request bodies go under `time_period`.** Both the create and the update wrap their fields in a `time_period` object, and every single-record response returns it under `time_period`.
* **`period` goes in upper case and comes back in lower case.** Send `MONTHLY`; the response shows `monthly`.
* **Time period ids start with `tp_`.** Pass that `id` as `time_period_id`.
* **`status` takes `active` or `inactive`.** Send it in an update to enable or disable a time period.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.