# Reset the test office (test mode)

Adresse: https://docs.athaus.ai/en/api/v1/referenz/reset-test-office

> Request, parameters, response and errors of POST /v1/test/reset.

Type: Reference
Last updated: 2026-11-14

Deletes everything in the test office and sets it back to its sample data: three listings, five contacts, two inquiries, one viewing, one file and one project with three units, all invented. Webhook endpoints and API keys stay. Projects go too: a key without write access to `projects` may reset only while the sample project is the only one. Only with a test key (404 with a live key). Because it deletes every resource, the key needs write access to all of them except `apiKeys`, which a reset never touches; a key narrowed to fewer resources gets 403. The office keeps its ID. A retry is safe with or without an `Idempotency-Key`: a reset is not kept under the key, so a second call resets again and leaves the same state.

Requires the scope [`propose`](/en/api/v1/anmeldung#scopes).

## Request [#request]

```http
POST https://api.athaus.ai/v1/test/reset
```

### Parameters [#parameters]

**Header**

| Name              | Type     | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ----------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Athaus-Version`  | `string` | no       | Optional and carries nothing a client needs: the version is the path. Accepted when it says `v1` or `1`. Any other value is a 400 `api_version_unsupported`.                                                                                                                                                                                                                                                                         |
| `Idempotency-Key` | `string` | no       | Makes a retry safe: the same key with the same body returns the first answer and writes nothing twice. A random value of at least 128 bits, for example a UUID, 1 to 255 characters. The key is kept for 24 hours and scoped to the API key and this operation. The same key with a different body is a 422; while the first request still runs it is a 409. Only successful answers are kept: after an error the key is free again. |

### Example [#example]

```bash
curl -X POST "https://api.athaus.ai/v1/test/reset" \
  -H "Authorization: Bearer ath_test_..." \
  -H "Idempotency-Key: $(uuidgen)"
```

## Response [#response]

On success the status is `200` with `TestReset`.

### TestReset [#testreset]

| Field              | Type                 | Description                                                                                                      |
| ------------------ | -------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `object`           | `string`             | Always `test_reset`.                                                                                             |
| `office`           | `object`             |                                                                                                                  |
| `office.object`    | `string`             | Always `office`.                                                                                                 |
| `office.id`        | `string`             | UUID of the test office. The same after every reset.                                                             |
| `resetAt`          | `string (date-time)` | When the test office was set back to the sample data.                                                            |
| `sample`           | `object`             | How many of each the sample data holds. Invented data: street names like Musterstraße, addresses on example.com. |
| `sample.listings`  | `integer`            |                                                                                                                  |
| `sample.contacts`  | `integer`            |                                                                                                                  |
| `sample.inquiries` | `integer`            |                                                                                                                  |
| `sample.viewings`  | `integer`            |                                                                                                                  |
| `sample.files`     | `integer`            |                                                                                                                  |
| `sample.projects`  | `integer`            |                                                                                                                  |
| `sample.units`     | `integer`            | The units of the sample project; each is also a listing.                                                         |

### Response headers [#response-headers]

| Header                | Description                                                                                                     |
| --------------------- | --------------------------------------------------------------------------------------------------------------- |
| `Request-Id`          | Identifies this request. Quote it in a support request.                                                         |
| `Athaus-Version`      | The API version of this response: v1.                                                                           |
| `Athaus-Release`      | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
| `RateLimit-Policy`    | The quota policy of the bucket that applies.                                                                    |
| `RateLimit`           | Remaining quota and seconds until the bucket is full again.                                                     |
| `Idempotent-Replayed` | `true` when this is the stored answer to an earlier request with the same Idempotency-Key.                      |

## Errors [#errors]

Every error arrives as [problem details](/en/api/v1/fehler). Branch on `code`, not on `title` or `detail`.

| Status | Codes                                                                                                                                                                         | Meaning                                                                                                     |
| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `400`  | [`api_version_unsupported`](/en/api/errors#api_version_unsupported)                                                                                                           | Invalid request.                                                                                            |
| `401`  | [`unauthorized`](/en/api/errors#unauthorized)                                                                                                                                 | Missing or invalid API key.                                                                                 |
| `403`  | [`insufficient_permissions`](/en/api/errors#insufficient_permissions), [`plan_required`](/en/api/errors#plan_required), [`test_office_full`](/en/api/errors#test_office_full) | The key lacks a right, or the plan does not include API access.                                             |
| `404`  | [`not_found`](/en/api/errors#not_found)                                                                                                                                       | Nothing under this ID.                                                                                      |
| `409`  | [`test_office_busy`](/en/api/errors#test_office_busy)                                                                                                                         | The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key. |
| `422`  |                                                                                                                                                                               | The idempotency key was already used with a different request body.                                         |
| `429`  | [`rate_limited`](/en/api/errors#rate_limited)                                                                                                                                 | Rate limit exceeded.                                                                                        |
| `500`  | [`internal_error`](/en/api/errors#internal_error)                                                                                                                             | Server error.                                                                                               |
