AthausDocs

Retrieve an inquiry

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

Last updated:

Requires the scope read and at least the level read on inquiries.

Try it in the console

Request

GET https://api.athaus.ai/v1/inquiries/{id}

Parameters

Path

NameTypeRequiredDescription
idstring (uuid)yesUUID of the inquiry.

Header

NameTypeRequiredDescription
Athaus-VersionstringnoOptional 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-MatchstringnoAn ETag you hold. If it is still current, the answer is 304 without a body.

Example

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

Response

On success the status is 200 with Inquiry.

Inquiry

FieldTypeDescription
objectstringAlways inquiry.
idstringUUID of the inquiry.
listingIdstringUUID of the property the inquiry is about.
statusstringWhere the office stands with this person. One of new, in_conversation, viewing_scheduled, accepted, declined.
sourcestringWhere the inquiry came from: athaus for the Athaus catalog, otherwise the channel or portal.
answeredbooleanThe office has replied.
replyablebooleanA reply can still reach the person, through Athaus or by mail.
namestringFirst name and the initial of the last name. The full name only for an inquiry through the catalog with contactConsent granted.
emailstring | nullNull for an inquiry through the catalog unless contactConsent is granted.
phonestring | nullNull for an inquiry through the catalog unless contactConsent is granted.
contactIdstring | nullUUID of the contact in the address book of the office. Null unless the person's contact is released.
contactConsentstringOne of not_required, granted, revoked, not_requested.
seekerobject | nullWhat 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.dealTypestringWhether the requested property is for sale or for rent. It decides which of the details below can be filled. One of buy, rent.
seeker.financingstring | nullBuy only. One of cash, mortgage_approved, mortgage_planned.
seeker.timeframestring | nullBuy: when to buy. Rent: when to move in. One of asap, within_3_months, within_6_months, flexible.
seeker.purposestring | nullBuy only. One of owner_occupied, investment.
seeker.budgetFitstring | nullBuy only. Whether the stated budget fits the price; never the amount. One of fits, tight, insufficient.
seeker.householdSizeinteger | nullRent only.
seeker.employmentstring | nullRent only. One of employed, self_employed, public_sector, retired, student, other.
seeker.hasPetsboolean | nullRent only.
seeker.documentsCountinteger | nullHow many papers the seeker shares. Never the papers themselves.
seeker.hasEquityboolean | nullBuy only. The seeker states equity; never the amount. Always true.
seeker.financingConfirmedboolean | nullBuy only. The seeker has a financing commitment. Always true.
seeker.countrySpecificobjectCountry sections, keys are lower-case ISO 3166-1 alpha-2 codes.
seeker.countrySpecific.deobject
seeker.countrySpecific.de.hasSubsidizedHousingCertificatebooleanA German certificate of eligibility for publicly subsidised housing (WBS) is on file. Rent only; present only when true. Always true.
createdAtstring (date-time)When the inquiry arrived.
updatedAtstring (date-time)When the inquiry record last changed. A new message does not change it.

Response headers

HeaderDescription
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.
ETagA 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-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining 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

Every error arrives as problem details. Branch on code, not on title or detail.

StatusCodesMeaning
400invalid_id, api_version_unsupported, invalid_inputInvalid 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.

Keep reading

On this page