List entity URLs

GET

https://api.aventure.vc/v1/entities/:entityId/urls

GET

/v1/entities/:entityId/urls

$ curl https://api.aventure.vc/v1/entities/entityId/urls \
>      -H "X-Client-Secret: <apiKey>"

1 {
2   "content": [
3     {
4       "url": "https://example.com",
5       "urlType": "website",
6       "crawlCdnProvider": "cloudflare",
7       "crawlRenderMode": "static",
8       "createdAt": "2024-01-15T09:30:00Z",
9       "id": 1,
10       "isCurrent": true,
11       "isPrimary": true,
12       "owner": {
13         "entityId": "string",
14         "personId": "string"
15       },
16       "sourceId": "string",
17       "status": "string",
18       "statusChecked": "2024-01-15T09:30:00Z",
19       "updatedAt": "2024-01-15T09:30:00Z"
20     }
21   ],
22   "empty": true,
23   "first": true,
24   "last": true,
25   "number": 1,
26   "numberOfElements": 1,
27   "pageable": {
28     "offset": 1,
29     "pageNumber": 1,
30     "pageSize": 1,
31     "paged": true,
32     "sort": {
33       "empty": true,
34       "sorted": true,
35       "unsorted": true
36     },
37     "unpaged": true
38   },
39   "size": 1,
40   "sort": {
41     "empty": true,
42     "sorted": true,
43     "unsorted": true
44   },
45   "totalElements": 1,
46   "totalPages": 1
47 }

Returns paged primary current URL rows owned by an entity. Set includeInactive=true with read auth to include secondary active and inactive/historical rows.

Authentication

X-Client-Secretstring

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

Path parameters

entityIdstringRequiredformat: "uuid"

Entity UUID owning the URL rows

Query parameters

includeInactivebooleanOptionalDefaults to false

Include secondary active and inactive/historical URL rows

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 25

The size of the page to be returned

sortlist of stringsOptional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

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

404

Not Found Error

406

Not Acceptable Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error