List inquiries
Request, parameters, response and errors of GET /v1/inquiries.
Last updated:
Returns the inquiries about the properties of the office, newest first by default. Page with nextCursor; follow changes with updatedSince and sort=updatedAt. updatedAt moves when the inquiry record changes (status, reply, assignment); a new message does not move it, so read new messages through GET /inquiries/{id}/messages. Name, email and phone of a person who inquired through the Athaus catalog are included only while that person has released their contact to the office (contactConsent). Needs read access to inquiries.
Requires the scope read and at least the level read on inquiries.
Request
GET https://api.athaus.ai/v1/inquiriesParameters
Query
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Page size, 1 to 100. More than 100 is rejected, never capped. Default 50. |
cursor | string | no | Opaque value from nextCursor of the previous page. |
updatedSince | string (date-time) | no | Only objects changed at or after this instant (ISO 8601). Combine with sort=updatedAt to follow changes. |
sort | string | no | Field to order by. A leading - sorts descending. One of createdAt, -createdAt, updatedAt, -updatedAt. Default -createdAt. |
listingId | string (uuid) | no | Only inquiries about this property. |
status | string | no | Only inquiries in this status. One of new, in_conversation, viewing_scheduled, accepted, declined. |
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. |
Example
curl "https://api.athaus.ai/v1/inquiries?limit=10" \
-H "Authorization: Bearer ath_live_..."Response
On success the status is 200 with InquiryList.
InquiryList
| Field | Type | Description |
|---|---|---|
object | string | Always list. |
data | Inquiry[] | |
hasMore | boolean | True if another page follows. |
nextCursor | string | null | Pass as cursor to get the next page. Null on the last page. |
Inquiry
| Field | Type | Description |
|---|---|---|
object | string | Always 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. One of 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 | One of 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. One of buy, rent. |
seeker.financing | string | null | Buy only. One of cash, mortgage_approved, mortgage_planned. |
seeker.timeframe | string | null | Buy: when to buy. Rent: when to move in. One of asap, within_3_months, within_6_months, flexible. |
seeker.purpose | string | null | Buy only. One of owner_occupied, investment. |
seeker.budgetFit | string | null | Buy only. Whether the stated budget fits the price; never the amount. One of fits, tight, insufficient. |
seeker.householdSize | integer | null | Rent only. |
seeker.employment | string | null | Rent only. One of 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. Always true. |
seeker.financingConfirmed | boolean | null | Buy only. The seeker has a financing commitment. Always 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. Always 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. |
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. |
RateLimit-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining quota and seconds until the bucket is full again. |
Errors
Every error arrives as problem details. Branch on code, not on title or detail.
| Status | Codes | Meaning |
|---|---|---|
400 | invalid_query, api_version_unsupported | 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. |
Keep reading
REST API: authentication with an API key
Every call to /v1 carries an API key as a bearer token. Where to get one, which scopes it carries and what does not work.
REST API: errors as problem details
Every error from /v1 is an RFC 9457 problem with a real HTTP status, a code to branch on and a request id for support.