AthausDoku

List projects

Aufruf, Parameter, Antwort und Fehler von GET /v1/projects.

Zuletzt aktualisiert:

Returns the external ids of the office's new-build projects, newest first, with a summary of each. Page with nextPageToken; follow changes with updatedSince. Needs read access to projects.

Braucht den Scope read und mindestens die Stufe read auf projects.

In der Konsole ausprobieren

Aufruf

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

Parameter

Abfrage

NameTypPflichtBeschreibung
limitintegerneinPage size, 1 to 100. More than 100 is rejected, never capped. Vorgabe 50.
nextPageTokenstringneinThe nextPageToken of the previous page.
updatedSincestring (date-time)neinOnly projects changed at or after this time.

Kopf

NameTypPflichtBeschreibung
Athaus-VersionstringneinOptional 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.

Beispiel

curl "https://api.athaus.ai/v1/projects?limit=10" \
  -H "Authorization: Bearer ath_live_..."

Antwort

Bei Erfolg kommt 200 mit ProjectIdList.

ProjectIdList

FeldTypBeschreibung
externalProjectIdsstring[]
nextPageTokenstring | any
projectsobject[]Ours, not OpenImmo: a summary of each project in the page.
projects[].projectIdstring
projects[].externalProjectIdstring
projects[].statusstring | any
projects[].updatedAtstring (date-time)

Köpfe der Antwort

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

Fehler

Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.

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

Weiter lesen

Auf dieser Seite