AthausDoku

List proposals

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

Zuletzt aktualisiert:

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.

In der Konsole ausprobieren

Aufruf

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

Parameter

Abfrage

NameTypPflichtBeschreibung
limitintegerneinPage size, 1 to 100. More than 100 is rejected, never capped. Vorgabe 50.
cursorstringneinOpaque value from nextCursor of the previous page.
sortstringneinField to order by. Newest first by default. Eines von createdAt, -createdAt. Vorgabe -createdAt.
statusstringneinOnly proposals in this status. Eines von pending, approved, executed, failed, rejected, expired.

Kopf

NameTypPflichtBeschreibung
Athaus-VersionstringneinOptional 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

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

Antwort

Bei Erfolg kommt 200 mit ProposalList.

ProposalList

FeldTypBeschreibung
objectstringImmer list.
dataProposal[]
hasMorebooleanTrue if another page follows.
nextCursorstring | nullPass as cursor to get the next page. Null on the last page.

Proposal

FeldTypBeschreibung
objectstringImmer proposal.
idstringUUID of the proposal.
statusstringEines von pending, approved, executed, failed, rejected, expired.
actionstringWhat 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.
targetobjectWhat the action is about: an inquiry, or the listing (its listingId) to publish.
target.objectstringEines von inquiry, listing.
target.idstring
textstringThe 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.
livemodebooleanfalse 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.
createdAtstring (date-time)
decidedAtstring (date-time) | nullWhen 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.
decidedByobject | nullThe API key that said yes or no. Null while pending and when a person or the office's automation decided.
decidedBy.objectstringImmer api_key.
decidedBy.idstring
decidedBy.namestring | null
executedAtstring (date-time) | nullWhen the message was delivered, or the listing went online. Null until then.

Köpfe der Antwort

KopfBeschreibung
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Fehler

Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.

StatusCodesBedeutung
400invalid_query, api_version_unsupportedInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Weiter lesen

Auf dieser Seite