# List proposals

Adresse: https://docs.athaus.ai/api/v1/referenz/list-proposals

> Aufruf, Parameter, Antwort und Fehler von GET /v1/proposals.

Typ: Referenz
Zuletzt aktualisiert: 2026-11-14

Returns the proposals this API key created, newest first by default. A proposal appears when an operation that reaches people outside the office, for example `POST /inquiries/{id}/messages`, is not allowed to go out right away; the answer to that call is 202 with a link to it. Filter by `status` to find what still waits (`pending`). Proposals of other keys, of people and of the automation of the office are not listed. A proposal has no time of change, so `updatedSince` is rejected as an unknown parameter. Needs read access to `inquiries`.

Braucht den Scope [`read`](/api/v1/anmeldung#scopes).

[In der Konsole ausprobieren](/api/v1/konsole?op=listProposals)

## Aufruf [#aufruf]

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

### Parameter [#parameter]

**Abfrage**

| Name     | Typ       | Pflicht | Beschreibung                                                                                                 |
| -------- | --------- | ------- | ------------------------------------------------------------------------------------------------------------ |
| `limit`  | `integer` | nein    | Page size, 1 to 100. More than 100 is rejected, never capped. Vorgabe `50`.                                  |
| `cursor` | `string`  | nein    | Opaque value from `nextCursor` of the previous page.                                                         |
| `sort`   | `string`  | nein    | Field to order by. Newest first by default. Eines von `createdAt`, `-createdAt`. Vorgabe `-createdAt`.       |
| `status` | `string`  | nein    | Only proposals in this status. Eines von `pending`, `approved`, `executed`, `failed`, `rejected`, `expired`. |

**Kopf**

| Name             | Typ      | Pflicht | Beschreibung                                                                                                                                                 |
| ---------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Athaus-Version` | `string` | nein    | 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`. |

### Beispiel [#beispiel]

```bash
curl "https://api.athaus.ai/v1/proposals?limit=10" \
  -H "Authorization: Bearer ath_live_..."
```

## Antwort [#antwort]

Bei Erfolg kommt `200` mit `ProposalList`.

### ProposalList [#proposallist]

| Feld         | Typ              | Beschreibung                                                  |
| ------------ | ---------------- | ------------------------------------------------------------- |
| `object`     | `string`         | Immer `list`.                                                 |
| `data`       | `Proposal[]`     |                                                               |
| `hasMore`    | `boolean`        | True if another page follows.                                 |
| `nextCursor` | `string \| null` | Pass as `cursor` to get the next page. Null on the last page. |

### Proposal [#proposal]

| Feld               | Typ                          | Beschreibung                                                                                                                                                                                                                |
| ------------------ | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object`           | `string`                     | Immer `proposal`.                                                                                                                                                                                                           |
| `id`               | `string`                     | UUID of the proposal.                                                                                                                                                                                                       |
| `status`           | `string`                     | Eines von `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. Eines von `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`                     | Eines von `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`                     | Immer `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.                                                                                                                                                |

### Köpfe der Antwort [#köpfe-der-antwort]

| Kopf               | Beschreibung                                                                                                    |
| ------------------ | --------------------------------------------------------------------------------------------------------------- |
| `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.                                                     |

## Fehler [#fehler]

Jeder Fehler kommt als [Problem Details](/api/v1/fehler). Verzweige auf `code`, nicht auf `title` oder `detail`.

| Status | Codes                                                                                                            | Bedeutung                                                       |
| ------ | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| `400`  | [`invalid_query`](/api/errors#invalid_query), [`api_version_unsupported`](/api/errors#api_version_unsupported)   | Invalid request.                                                |
| `401`  | [`unauthorized`](/api/errors#unauthorized)                                                                       | Missing or invalid API key.                                     |
| `403`  | [`insufficient_permissions`](/api/errors#insufficient_permissions), [`plan_required`](/api/errors#plan_required) | The key lacks a right, or the plan does not include API access. |
| `404`  | [`not_found`](/api/errors#not_found)                                                                             | Nothing under this ID.                                          |
| `429`  | [`rate_limited`](/api/errors#rate_limited)                                                                       | Rate limit exceeded.                                            |
| `500`  | [`internal_error`](/api/errors#internal_error)                                                                   | Server error.                                                   |
