AthausDoku

Retrieve a contact

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

Zuletzt aktualisiert:

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/{id}

Parameter

Pfad

NameTypPflichtBeschreibung
idstring (uuid)jaUUID of the contact.

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.
If-None-MatchstringneinAn ETag you hold. If it is still current, the answer is 304 without a body.

Beispiel

curl "https://api.athaus.ai/v1/contacts/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
  -H "Authorization: Bearer ath_live_..."

Antwort

Bei Erfolg kommt 200 mit Contact.

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.
ETagA strong entity tag of this state of the resource. Send it as If-Match to change or delete the resource only if it is unchanged, or as If-None-Match to read it only if it changed.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Mit If-None-Match auf den aktuellen ETag antwortet die Operation 304 ohne Rumpf.

Fehler

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

StatusCodesBedeutung
400invalid_id, api_version_unsupported, invalid_inputInvalid 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