Search entity classification tags

GET

https://api.aventure.vc/v1/classifications/tags

GET

/v1/classifications/tags

$ curl -G https://api.aventure.vc/v1/classifications/tags \
>      -H "X-Client-Secret: <apiKey>" \
>      -d q=enterprise \
>      -d type=revenueModel

1 {
2   "content": [
3     {
4       "creatable": true,
5       "name": "string",
6       "writable": true,
7       "id": 1,
8       "type": "industry",
9       "isCurrent": true,
10       "isPrimary": true,
11       "bucket": "string",
12       "classificationId": 1,
13       "createdAt": "2024-01-15T09:30:00Z",
14       "slug": "aventure-vc",
15       "updatedAt": "2024-01-15T09:30:00Z"
16     }
17   ],
18   "empty": true,
19   "first": true,
20   "last": true,
21   "number": 1,
22   "numberOfElements": 1,
23   "pageable": {
24     "offset": 1,
25     "pageNumber": 1,
26     "pageSize": 1,
27     "paged": true,
28     "sort": {
29       "empty": true,
30       "sorted": true,
31       "unsorted": true
32     },
33     "unpaged": true
34   },
35   "size": 1,
36   "sort": {
37     "empty": true,
38     "sorted": true,
39     "unsorted": true
40   },
41   "totalElements": 1,
42   "totalPages": 1
43 }

Returns a paginated list of active tags from the entity classification registry. Filter by bucket via type (any spelling listed on the corresponding ClassificationCatalogBucket — type plus its alias[]) and optionally by a name keyword via q. Results are ordered by bucket then by name; sorting is not supported — sort returns 422. Dormant registry tags are not returned by this read surface.

Returns a paginated list of active tags from the entity classification registry. Filter by bucket via `type` (any spelling listed on the corresponding ClassificationCatalogBucket — `type` plus its `alias[]`) and optionally by a name keyword via `q`. Results are ordered by bucket then by name; sorting is not supported — `sort` returns 422. Dormant registry tags are not returned by this read surface.

Authentication

X-Client-Secretstring

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

Query parameters

typestringOptional

Classification bucket. Case- and punctuation-insensitive. Accepts the bucket wire value or any entry from its alias[] — discover both via GET /v1/classifications/catalog?includeTags=false.

qstringOptional

Case-insensitive name substring filter (e.g. ‘enterprise’).

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

406

Not Acceptable Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error