aVenture APISitemap

Paginated thin entity directory

View as Markdown

Large paginated list serving front-end directory and sitemap traversal; not an enrichment read or write surface. Returns thin Entity rows newest updatedAt first, filtered only by typeRecord and letter. totalElements counts every match; offset pages stop at 5000 rows, so follow X-Next-Cursor for deep traversal. Sort is fixed.

Query parameters

typeRecordlist of enumsOptional
Entity types to include. Repeat for multiple types.
letterstringOptional
First letter of the display name.
cursorstringOptional

Cursor for pagination (format: timestamp::uuid)

permitMonogrambooleanOptional
Allow generated monogram logos in results.
includePrivatebooleanOptional

Includes hidden or off-sitemap entities when the caller has private-visibility authority. Omit to use the caller’s default visibility.

pageintegerOptional>=0

Zero-based page index (0..N)

sizeintegerOptional>=1
The size of the page to be returned

Response headers

X-Next-CursorstringOptional

Opaque continuation token; reuse the same filters and forward unchanged.

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 objectsOptional
emptybooleanOptional
firstbooleanOptional
lastbooleanOptional
numberintegerOptional
numberOfElementsintegerOptional
pageableobjectOptional
sizeintegerOptional
sortobjectOptional
totalElementslongOptional
totalPagesintegerOptional

Errors

400
Bad Request Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error