AthausDoku

List contacts

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

Zuletzt aktualisiert:

Returns the contacts of the office, newest first by default. Needs read access to contacts.

Braucht den Scope read und mindestens die Stufe read auf contacts. Diesen Zugriff bekommt nur ein Key, den die Leitung des Büros angelegt hat.

In der Konsole ausprobieren

Aufruf

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

Parameter

Abfrage

NameTypPflichtBeschreibung
limitintegerneinPage size, 1 to 100. More than 100 is rejected, never capped. Vorgabe 50.
cursorstringneinOpaque value from nextCursor of the previous page.
updatedSincestring (date-time)neinOnly objects changed at or after this instant (ISO 8601). Combine with sort=updatedAt to follow changes.
sortstringneinField to order by. A leading - sorts descending. Eines von createdAt, -createdAt, updatedAt, -updatedAt. Vorgabe -createdAt.
emailstringneinExact address, case-insensitive.
citystringneinExact city, case-insensitive.
postalCodestringnein
tagstringneinOnly contacts carrying this tag.

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/contacts?limit=10" \
  -H "Authorization: Bearer ath_live_..."

Antwort

Bei Erfolg kommt 200 mit ContactList.

ContactList

FeldTypBeschreibung
objectstringImmer list.
dataContact[]
hasMorebooleanTrue if another page follows.
nextCursorstring | nullPass as cursor to get the next page. Null on the last page.

Contact

FeldTypBeschreibung
objectstringImmer contact.
idstringUUID of the contact.
salutationstring | nullEines von ms, mr, mx.
firstNamestring | null
lastNamestring | null
displayNamestringHow the contact is named in every list: last name first, or what makes the contact reachable.
companystring | null
emailstring | null
phonestring | null
streetstring | null
postalCodestring | null
citystring | null
tagsstring[]
sourcestringWhere the contact came from, for example manual, an import or a connected system.
createdAtstring (date-time)
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