# Retrieve a proposal

Adresse: https://docs.athaus.ai/en/api/v1/referenz/get-proposal

> Request, parameters, response and errors of GET /v1/proposals/{id}.

Type: Reference
Last updated: 2026-11-14

Returns one proposal of this API key with its current `status`. Poll it after a 202 until it leaves `pending`: `approved` means a person said yes and the message is queued, `executed` means it was delivered. Needs read access to `inquiries`.

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

[Try it in the console](/en/api/v1/konsole?op=getProposal)

## Request [#request]

```http
GET https://api.athaus.ai/v1/proposals/{id}
```

### Parameters [#parameters]

**Path**

| Name | Type            | Required | Description           |
| ---- | --------------- | -------- | --------------------- |
| `id` | `string (uuid)` | yes      | UUID of the proposal. |

**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`. |
| `If-None-Match`  | `string` | no       | An ETag you hold. If it is still current, the answer is 304 without a body.                                                                                  |

### Example [#example]

```bash
curl "https://api.athaus.ai/v1/proposals/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
  -H "Authorization: Bearer ath_live_..."
```

## Response [#response]

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

### Proposal [#proposal]

| Field              | Type                         | Description                                                                                                                                                                                                              |
| ------------------ | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `object`           | `string`                     | Always `proposal`.                                                                                                                                                                                                       |
| `id`               | `string`                     | UUID of the proposal.                                                                                                                                                                                                    |
| `status`           | `string`                     | One of `pending`, `approved`, `executed`, `failed`, `rejected`, `expired`.                                                                                                                                               |
| `action`           | `string`                     | What the proposal does once it is approved. The list is open: new actions arrive, and a client treats an unknown one as a proposal it follows by status. One of `inquiry.reply`, `inquiry.follow_up`, `listing.publish`. |
| `target`           | `object`                     | What the action is about: an inquiry, or the listing (its `listingId`) to publish.                                                                                                                                       |
| `target.object`    | `string`                     | One of `inquiry`, `listing`.                                                                                                                                                                                             |
| `target.id`        | `string`                     |                                                                                                                                                                                                                          |
| `text`             | `string`                     | The message that goes to the person who inquired; for `listing.publish` a sentence naming the listing. Where a human changed a message before approving, the changed text.                                               |
| `livemode`         | `boolean`                    | `false` for a proposal of the test office (test keys): approving it records the message as sent in the thread with a note that it was not delivered, and nothing leaves Athaus.                                          |
| `createdAt`        | `string (date-time)`         |                                                                                                                                                                                                                          |
| `decidedAt`        | `string (date-time) \| null` | When a human, an API key with the scope `decide` or the automation of the office said yes or no, or the proposal expired. Null while pending.                                                                            |
| `decidedBy`        | `object \| null`             | The API key that said yes or no. Null while pending and when a person or the office's automation decided.                                                                                                                |
| `decidedBy.object` | `string`                     | Always `api_key`.                                                                                                                                                                                                        |
| `decidedBy.id`     | `string`                     |                                                                                                                                                                                                                          |
| `decidedBy.name`   | `string \| null`             |                                                                                                                                                                                                                          |
| `executedAt`       | `string (date-time) \| null` | When the message was delivered, or the listing went online. Null until then.                                                                                                                                             |

### 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.                                                                         |
| `ETag`             | A strong entity tag of this state of the resource. Send it as `If-Match` to change or delete the resource only if it is unchanged, or as `If-None-Match` to read it only if it changed. |
| `RateLimit-Policy` | The quota policy of the bucket that applies.                                                                                                                                            |
| `RateLimit`        | Remaining quota and seconds until the bucket is full again.                                                                                                                             |

With `If-None-Match` naming the current `ETag`, the operation answers `304` without a body.

## Errors [#errors]

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

| Status | Codes                                                                                                                                                           | Meaning                                                         |
| ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| `400`  | [`invalid_id`](/en/api/errors#invalid_id), [`api_version_unsupported`](/en/api/errors#api_version_unsupported), [`invalid_input`](/en/api/errors#invalid_input) | 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)                                          | 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.                                          |
| `429`  | [`rate_limited`](/en/api/errors#rate_limited)                                                                                                                   | Rate limit exceeded.                                            |
| `500`  | [`internal_error`](/en/api/errors#internal_error)                                                                                                               | Server error.                                                   |
