List listings
Request, parameters, response and errors of GET /v1/listings.
Last updated:
Returns the external ids of the office's listings, newest first, with a summary of each. Page with nextPageToken; follow changes with updatedSince.
Requires the scope read.
Request
GET https://api.athaus.ai/v1/listingsParameters
Query
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Page size, 1 to 100. More than 100 is rejected, never capped. Default 50. |
nextPageToken | string | no | The nextPageToken of the previous page. |
updatedSince | string (date-time) | no | Only listings changed at or after this time. |
status | string | no | One of draft, active, paused, reserved, closed. |
distributionType | string | no | One of BUY, RENT. |
city | string | no | |
postalcode | string | no |
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/listings?limit=10" \
-H "Authorization: Bearer ath_live_..."Response
On success the status is 200 with ListingIdList.
ListingIdList
| Field | Type | Description |
|---|---|---|
externalListingIds | string[] | |
nextPageToken | string | any | |
listings | object[] | Additive summary of the same listings. |
listings[].listingId | string (uuid) | |
listings[].externalListingId | string | |
listings[].status | string | |
listings[].updatedAt | string (date-time) |
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.