Retrieve an inquiry
Aufruf, Parameter, Antwort und Fehler von GET /v1/inquiries/{id}.
Zuletzt aktualisiert:
Braucht den Scope read und mindestens die Stufe read auf inquiries.
Aufruf
GET https://api.athaus.ai/v1/inquiries/{id}Parameter
Pfad
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string (uuid) | ja | UUID of the inquiry. |
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. |
If-None-Match | string | nein | An ETag you hold. If it is still current, the answer is 304 without a body. |
Beispiel
curl "https://api.athaus.ai/v1/inquiries/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
-H "Authorization: Bearer ath_live_..."Antwort
Bei Erfolg kommt 200 mit Inquiry.
Inquiry
| Feld | Typ | Beschreibung |
|---|---|---|
object | string | Immer inquiry. |
id | string | UUID of the inquiry. |
listingId | string | UUID of the property the inquiry is about. |
status | string | Where the office stands with this person. Eines von new, in_conversation, viewing_scheduled, accepted, declined. |
source | string | Where the inquiry came from: athaus for the Athaus catalog, otherwise the channel or portal. |
answered | boolean | The office has replied. |
replyable | boolean | A reply can still reach the person, through Athaus or by mail. |
name | string | First name and the initial of the last name. The full name only for an inquiry through the catalog with contactConsent granted. |
email | string | null | Null for an inquiry through the catalog unless contactConsent is granted. |
phone | string | null | Null for an inquiry through the catalog unless contactConsent is granted. |
contactId | string | null | UUID of the contact in the address book of the office. Null unless the person's contact is released. |
contactConsent | string | Eines von not_required, granted, revoked, not_requested. |
seeker | object | null | What the seeker shared about themselves, as categories. Null for an inquiry from outside, for a deleted account, without a profile, and after consent was revoked. |
seeker.dealType | string | Whether the requested property is for sale or for rent. It decides which of the details below can be filled. Eines von buy, rent. |
seeker.financing | string | null | Buy only. Eines von cash, mortgage_approved, mortgage_planned. |
seeker.timeframe | string | null | Buy: when to buy. Rent: when to move in. Eines von asap, within_3_months, within_6_months, flexible. |
seeker.purpose | string | null | Buy only. Eines von owner_occupied, investment. |
seeker.budgetFit | string | null | Buy only. Whether the stated budget fits the price; never the amount. Eines von fits, tight, insufficient. |
seeker.householdSize | integer | null | Rent only. |
seeker.employment | string | null | Rent only. Eines von employed, self_employed, public_sector, retired, student, other. |
seeker.hasPets | boolean | null | Rent only. |
seeker.documentsCount | integer | null | How many papers the seeker shares. Never the papers themselves. |
seeker.hasEquity | boolean | null | Buy only. The seeker states equity; never the amount. Immer true. |
seeker.financingConfirmed | boolean | null | Buy only. The seeker has a financing commitment. Immer true. |
seeker.countrySpecific | object | Country sections, keys are lower-case ISO 3166-1 alpha-2 codes. |
seeker.countrySpecific.de | object | |
seeker.countrySpecific.de.hasSubsidizedHousingCertificate | boolean | A German certificate of eligibility for publicly subsidised housing (WBS) is on file. Rent only; present only when true. Immer true. |
createdAt | string (date-time) | When the inquiry arrived. |
updatedAt | string (date-time) | When the inquiry record last changed. A new message does not change it. |
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. |
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. |
Mit If-None-Match auf den aktuellen ETag antwortet die Operation 304 ohne Rumpf.
Fehler
Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.
| Status | Codes | Bedeutung |
|---|---|---|
400 | invalid_id, api_version_unsupported, invalid_input | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Weiter lesen
REST-API: Anmeldung mit einem API-Key
Jeder Aufruf von /v1 trägt einen API-Key als Bearer-Token. Wo du ihn bekommst, welche Scopes er trägt und was nicht geht.
REST-API: Fehler als Problem Details
Jeder Fehler von /v1 ist ein Problem nach RFC 9457 mit echtem HTTP-Status, einem Code zum Verzweigen und einer Request-Id für den Support.