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.
Aufruf
GET https://api.athaus.ai/v1/contactsParameter
Abfrage
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
limit | integer | nein | Page size, 1 to 100. More than 100 is rejected, never capped. Vorgabe 50. |
cursor | string | nein | Opaque value from nextCursor of the previous page. |
updatedSince | string (date-time) | nein | Only objects changed at or after this instant (ISO 8601). Combine with sort=updatedAt to follow changes. |
sort | string | nein | Field to order by. A leading - sorts descending. Eines von createdAt, -createdAt, updatedAt, -updatedAt. Vorgabe -createdAt. |
email | string | nein | Exact address, case-insensitive. |
city | string | nein | Exact city, case-insensitive. |
postalCode | string | nein | |
tag | string | nein | Only contacts carrying this tag. |
Kopf
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
Athaus-Version | string | nein | 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. |
Beispiel
curl "https://api.athaus.ai/v1/contacts?limit=10" \
-H "Authorization: Bearer ath_live_..."Antwort
Bei Erfolg kommt 200 mit ContactList.
ContactList
| Feld | Typ | Beschreibung |
|---|---|---|
object | string | Immer list. |
data | Contact[] | |
hasMore | boolean | True if another page follows. |
nextCursor | string | null | Pass as cursor to get the next page. Null on the last page. |
Contact
| Feld | Typ | Beschreibung |
|---|---|---|
object | string | Immer contact. |
id | string | UUID of the contact. |
salutation | string | null | Eines von ms, mr, mx. |
firstName | string | null | |
lastName | string | null | |
displayName | string | How the contact is named in every list: last name first, or what makes the contact reachable. |
company | string | null | |
email | string | null | |
phone | string | null | |
street | string | null | |
postalCode | string | null | |
city | string | null | |
tags | string[] | |
source | string | Where the contact came from, for example manual, an import or a connected system. |
createdAt | string (date-time) | |
updatedAt | string (date-time) |
Köpfe der Antwort
| Kopf | Beschreibung |
|---|---|
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. |
Fehler
Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.
| Status | Codes | Bedeutung |
|---|---|---|
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. |
Weiter lesen
REST-API: Anmeldung mit einem API-Key
Jeder Aufruf von /v1 trägt einen API-Key als Bearer-Token. Wo du ihn bekommst, welche Scopes er trägt und was nicht geht.
REST-API: Fehler als Problem Details
Jeder Fehler von /v1 ist ein Problem nach RFC 9457 mit echtem HTTP-Status, einem Code zum Verzweigen und einer Request-Id für den Support.