Skip to navigation
aVenture APIAddresses

List Address Links

View as Markdown

Returns entity and person association ids, owner ids, and nullable roles for a physical address, including historical associations. Only publicly visible owners are returned unless private visibility is authorized. Entity links precede person links; each group is ordered by join id. Bounded keyset pagination avoids counting or loading every owner. Follow nextCursor, also returned as X-Next-Cursor. An absent or unlinked address returns empty content. Page must be zero and sort is unsupported.

Authentication

AuthorizationBearer

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

Path parameters

addressIdintegerRequired
Physical address row id, not an association join id.

Query parameters

pageintegerOptional>=0

Offset paging is not supported; omit page. Any value other than 0 returns 400. Send the previous response’s nextCursor as cursor to read the next page.

sizeintegerOptional>=1
The size of the page to be returned
cursorstringOptional
Opaque continuation from this address's previous response.

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
contentlist of objects
nextCursorstring or nullOptional

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