Fetch the entity classification taxonomy

GET

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

GET

/v1/classifications/catalog

$ curl -G https://api.aventure.vc/v1/classifications/catalog \
>      -H "X-Client-Secret: <apiKey>" \
>      -d bucketType=industry

1 {
2   "bucket": [
3     {
4       "alias": [
5         "string"
6       ],
7       "creatable": true,
8       "hierarchical": true,
9       "label": "string",
10       "tag": [
11         {
12           "creatable": true,
13           "name": "string",
14           "writable": true,
15           "id": 1,
16           "type": "industry",
17           "isCurrent": true,
18           "isPrimary": true,
19           "bucket": "string",
20           "classificationId": 1,
21           "createdAt": "2024-01-15T09:30:00Z",
22           "slug": "aventure-vc",
23           "updatedAt": "2024-01-15T09:30:00Z"
24         }
25       ],
26       "tagCount": 1,
27       "type": "string",
28       "writable": true,
29       "bucket": "string"
30     }
31   ],
32   "category": [
33     {
34       "alias": [
35         "string"
36       ],
37       "category": "string",
38       "classification": [
39         {
40           "creatable": true,
41           "name": "string",
42           "writable": true,
43           "category": "string",
44           "id": 1,
45           "isCurrent": true,
46           "isPrimary": true,
47           "code": 1,
48           "createdAt": "2024-01-15T09:30:00Z",
49           "entityClassificationId": 1,
50           "level": 1,
51           "updatedAt": "2024-01-15T09:30:00Z"
52         }
53       ],
54       "classificationCount": 1,
55       "creatable": true,
56       "hierarchical": true,
57       "label": "string",
58       "writable": true
59     }
60   ],
61   "generatedAt": "2024-01-15T09:30:00Z",
62   "totalBucket": 1,
63   "totalCategory": 1,
64   "totalStandardizedClassification": 1,
65   "totalTag": 1
66 }

Returns active classification buckets with optional tag lists. Each bucket carries its canonical type, accepted alias[] spellings, tagCount, and (when includeTags=true) the active tag[]. Use bucketType to scope to one bucket and includeTags=false to fetch metadata only. For tag ids, prefer classifications tags --type <bucket> --q <name> over broad catalog JSON; use returned tag.id as EntityClassificationMutation.tagId when writing classifications. Dormant registry tags are intentionally omitted; type + name writes that find one return 409 with inactiveTagOverride recovery choices.

Returns active classification buckets with optional tag lists. Each bucket carries its canonical `type`, accepted `alias[]` spellings, `tagCount`, and (when includeTags=true) the active `tag[]`. Use bucketType to scope to one bucket and includeTags=false to fetch metadata only. For tag ids, prefer `classifications tags --type <bucket> --q <name>` over broad catalog JSON; use returned tag.id as EntityClassificationMutation.tagId when writing classifications. Dormant registry tags are intentionally omitted; type + name writes that find one return 409 with inactiveTagOverride recovery choices.

Authentication

X-Client-Secretstring

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

Query parameters

bucketTypestringOptional

Optional classification bucket. Accepts the same values as the tags endpoint type parameter.

includeTagsbooleanOptional

When false, returns bucket metadata without tag arrays. For tag ids, prefer classifications tags with type and q filters instead of broad catalog JSON.

Response

bucketlist of objects

categorylist of objects

generatedAtdatetime

totalBucketinteger

totalCategoryinteger

totalStandardizedClassificationinteger

totalTaginteger

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