> For the complete documentation index, see [llms.txt](https://docs.flashback.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flashback.tech/support-reference/platform-api-reference/settings.md).

# Settings

This file outlines the Flashgate API’s settings management features, allowing you to configure and retrieve **user** and **organization** preferences. Both layers support full replacement, partial updates, and selective deletion of keys. Authentication is required for all operations.

{% hint style="info" %}
To perform these operations, you must be authenticated by means of one of the following methods: [BearerAuth](https://docs.flashback.tech/support-reference/platform-api-reference.md#http-bearer-authentication).
{% endhint %}

## Settings API Calls <a href="#flashgate-api-settings" id="flashgate-api-settings"></a>

### User Settings

| Method                                                    | API Reference                                                                                                                          | Description                                                  |
| --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| <mark style="color:green;">`GET`</mark>`/settings/user`   | [**get\_\_settings\_user**](https://docs.flashback.tech/support-reference/platform-api-reference/settings/get__settings_user.md)       | Retrieve the current user’s settings.                        |
| <mark style="color:orange;">`POST`</mark>`/settings/user` | [**post\_\_settings\_user**](https://docs.flashback.tech/support-reference/platform-api-reference/settings/post__settings_user.md)     | Replace all user settings with the provided object.          |
| <mark style="color:blue;">`PUT`</mark>`/settings/user`    | [**put\_\_settings\_user**](https://docs.flashback.tech/support-reference/platform-api-reference/settings/put__settings_user.md)       | Partially update user settings, preserving unspecified keys. |
| <mark style="color:red;">`DELETE`</mark>`/settings/user`  | [**delete\_\_settings\_user**](https://docs.flashback.tech/support-reference/platform-api-reference/settings/delete__settings_user.md) | Delete specific user settings keys.                          |

### Organization Settings

| Method                                                            | API Reference                                                                                                                                          | Description                                                 |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
| <mark style="color:green;">`GET`</mark>`/settings/organization`   | [**get\_\_settings\_organization**](https://docs.flashback.tech/support-reference/platform-api-reference/settings/get__settings_organization.md)       | Retrieve the current organization’s settings.               |
| <mark style="color:orange;">`POST`</mark>`/settings/organization` | [**post\_\_settings\_organization**](https://docs.flashback.tech/support-reference/platform-api-reference/settings/post__settings_organization.md)     | Replace all organization settings with the provided object. |
| <mark style="color:blue;">`PUT`</mark>`/settings/organization`    | [**put\_\_settings\_organization**](https://docs.flashback.tech/support-reference/platform-api-reference/settings/put__settings_organization.md)       | Partially update organization settings.                     |
| <mark style="color:red;">`DELETE`</mark>`/settings/organization`  | [**delete\_\_settings\_organization**](https://docs.flashback.tech/support-reference/platform-api-reference/settings/delete__settings_organization.md) | Delete specific organization settings keys.                 |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flashback.tech/support-reference/platform-api-reference/settings.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
