Batch entity detail retrieval (POST)

View as Markdown
Returns a page envelope of entity detail records by id, slug, and/or current joined URL. When page and size are omitted, the full deduplicated batch is returned in request order. Sort is not supported for this fixed-order batch response. For public reads totalElements counts the entities visible to the caller, so requested identifiers that do not resolve or fail the public visibility filter are excluded. For privileged reads totalElements counts the requested identifiers that resolved to an entity id, which can exceed the number of records returned when an id no longer exists.

Authentication

X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Query parameters

includePrivatebooleanOptional

Privileged read scope for admin callers. Bypasses the public visibility filter so hidden, unverified, and not-yet-published entities are returned instead of being silently dropped. Defaults to private for admin API key or ROLE_ADMIN callers; client-secret/client-read callers stay public.

pageintegerOptional

Zero-based page index (0..N); omit page and size for the full batch.

sizeintegerOptional

The size of the page to be returned; omit page and size for the full batch.

Request

This endpoint expects an object.
idlist of stringsOptional
Entity UUID values
permitMonogramboolean or nullOptionalDefaults to true
Permit monogram fallbacks
sluglist of stringsOptional
Entity slug values
urllist of stringsOptional
Current joined entity URL values

Response

OK
contentlist of objectsOptional
emptybooleanOptional
firstbooleanOptional
lastbooleanOptional
numberintegerOptional
numberOfElementsintegerOptional
pageableobjectOptional
sizeintegerOptional
sortobjectOptional
totalElementslongOptional
totalPagesintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error