AthausDocs

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.

Try it in the console

Request

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

Parameters

Query

NameTypeRequiredDescription
limitintegernoPage size, 1 to 100. More than 100 is rejected, never capped. Default 50.
nextPageTokenstringnoThe nextPageToken of the previous page.
updatedSincestring (date-time)noOnly listings changed at or after this time.
statusstringnoOne of draft, active, paused, reserved, closed.
distributionTypestringnoOne of BUY, RENT.
citystringno
postalcodestringno

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.

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

FieldTypeDescription
externalListingIdsstring[]
nextPageTokenstring | any
listingsobject[]Additive summary of the same listings.
listings[].listingIdstring (uuid)
listings[].externalListingIdstring
listings[].statusstring
listings[].updatedAtstring (date-time)

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.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Errors

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

StatusCodesMeaning
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.

Keep reading

On this page