Paginated sitemap-routes projection for an entity type

GET

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

GET

/v1/entities/sitemap-routes

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

1 {
2   "content": [
3     {
4       "id": "string",
5       "image": {
6         "isMonogram": true,
7         "logo": "string",
8         "logoSquare": "string"
9       },
10       "nameAlias": [
11         {
12           "name": "Bun",
13           "displayable": true,
14           "type": "alternativeDba"
15         }
16       ],
17       "nameBrand": "string",
18       "slug": "aventure-vc",
19       "createdAt": "2024-01-15T09:30:00Z",
20       "defaultCurrency": "string",
21       "foundedYear": 1,
22       "lastModifiedAt": "2024-01-15T09:30:00Z",
23       "nameLegal": "string",
24       "operatingStatus": "string",
25       "publicId": "eV1StGXR8Z5a",
26       "publicUrl": "string",
27       "sitemap": {
28         "hasAnalysis": true,
29         "hasEmployees": true,
30         "hasFundraising": true,
31         "hasNews": true,
32         "productServiceSlug": [
33           "string"
34         ],
35         "hasAcquisitions": false
36       },
37       "typeRecord": "Company",
38       "updatedAt": "2024-01-15T09:30:00Z"
39     }
40   ],
41   "empty": true,
42   "first": true,
43   "last": true,
44   "number": 1,
45   "numberOfElements": 1,
46   "pageable": {
47     "offset": 1,
48     "pageNumber": 1,
49     "pageSize": 1,
50     "paged": true,
51     "sort": {
52       "empty": true,
53       "sorted": true,
54       "unsorted": true
55     },
56     "unpaged": true
57   },
58   "size": 1,
59   "sort": {
60     "empty": true,
61     "sorted": true,
62     "unsorted": true
63   },
64   "totalElements": 1,
65   "totalPages": 1
66 }

Large paginated list serving front-end sitemap.xml generation; not an enrichment read or write surface. Returns thin Entity rows enriched with EntitySitemap gate booleans plus a bounded list of product/service child slugs; one row per company. Eligibility for /analysis, /fundraising, /employees, /news, and /products-services/{slug} is served from a materialized projection refreshed asynchronously after writes, so rows are eventually consistent and can lag a recent relationship or visibility change.

Authentication

X-Client-Secretstring

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

Query parameters

typeRecordenumRequired

Entity type whose sitemap rows to list.

cursorstringOptional

Cursor for pagination (format: timestamp::uuid)

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