Skip to navigation

List a Person's Contact Details

View as Markdown

Every email and phone of one person, primary first, each with its usage and opt-out state. A signed-in user’s read that returns contacts charges the record’s profile view against the monthly entity or person view allowance, shared with profile reads: once per record per UTC month, a read returning no contacts is free, and an exhausted cap answers 429 with Retry-After. Without edit permission it serves only a publicly visible record and omits opted-out rows.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Path parameters

personIdstringRequiredformat: "uuid"
Person UUID.

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
contactTypeenum

Kind of contact value: an email address or a phone number.

Allowed values:
contactUsageenum

Whether a contact reaches its owner personally or at work. PERSONAL: a personal mailbox or phone, always for a public email service domain (gmail.com, outlook.com, icloud.com, …). WORK: an address at a business, government, or non-profit domain, always for a government domain, by default for a company’s website domain. UNDETERMINED: stated only after checking the domain and finding no evidence either way, never as a shortcut. The server applies PERSONAL and WORK itself when its rule decides.

Allowed values:
contactValuestring

Stored value: an email trimmed and lower-cased, or a phone reduced to digits with an optional leading +.

createdAtdatetime
idinteger
Contact detail id.
isPrimaryboolean
Whether this is the owner's primary contact of its type.
ownerobject
The company or person this contact reaches.
suppressedboolean

True when the email is on the sales-lead opt-out list: never contact it for outreach or marketing. Read live from the opt-out list, so an opt-out applies at once. Always false for a phone.

updatedAtdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error