Paginated sitemap URL slots for entity types

GET

https://api.aventure.vc/v1/entities/sitemap-urls

GET

/v1/entities/sitemap-urls

$ curl -G https://api.aventure.vc/v1/entities/sitemap-urls \
>      -H "X-Client-Secret: <apiKey>" \
>      -d typeRecord=string

1 {
2   "content": [
3     {
4       "entityId": "string",
5       "lastUpdatedAt": "2024-01-15T09:30:00Z",
6       "path": "string",
7       "slotKey": "string",
8       "slug": "aventure-vc",
9       "typeRecord": "Company",
10       "urlType": "overview",
11       "productServiceSlug": "aventure-vc"
12     }
13   ],
14   "empty": true,
15   "first": true,
16   "last": true,
17   "number": 1,
18   "numberOfElements": 1,
19   "pageable": {
20     "offset": 1,
21     "pageNumber": 1,
22     "pageSize": 1,
23     "paged": true,
24     "sort": {
25       "empty": true,
26       "sorted": true,
27       "unsorted": true
28     },
29     "unpaged": true
30   },
31   "size": 1,
32   "sort": {
33     "empty": true,
34     "sorted": true,
35     "unsorted": true
36   },
37   "totalElements": 1,
38   "totalPages": 1
39 }

Large paginated list serving front-end sitemap.xml generation; not an enrichment read or write surface. Returns one row per concrete entity URL; the slot path and lastmod come from a materialized projection refreshed asynchronously after writes, so rows are eventually consistent. XML page limits count URLs, not parent entities.

Authentication

X-Client-Secretstring

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

Query parameters

typeRecordlist of stringsRequired

Entity type filters whose sitemap URLs to list. Repeat for multiple types.

cursorstringOptional

Cursor for pagination (format: timestamp::slotKey)

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 5000

The size of the page to be returned

Response

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

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error