AthausDocs

List contacts

Request, parameters, response and errors of GET /v1/contacts.

Last updated:

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

Requires the scope read and at least the level read on contacts. Only a key created by the management of the office gets this access.

Try it in the console

Request

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

Parameters

Query

NameTypeRequiredDescription
limitintegernoPage size, 1 to 100. More than 100 is rejected, never capped. Default 50.
cursorstringnoOpaque value from nextCursor of the previous page.
updatedSincestring (date-time)noOnly objects changed at or after this instant (ISO 8601). Combine with sort=updatedAt to follow changes.
sortstringnoField to order by. A leading - sorts descending. One of createdAt, -createdAt, updatedAt, -updatedAt. Default -createdAt.
emailstringnoExact address, case-insensitive.
citystringnoExact city, case-insensitive.
postalCodestringno
tagstringnoOnly contacts carrying this tag.

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

Response

On success the status is 200 with ContactList.

ContactList

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

Contact

FieldTypeDescription
objectstringAlways contact.
idstringUUID of the contact.
salutationstring | nullOne of 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)

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