Subcategories

This module can be used to create and list subcategories (token templates)

Token Templates are the barebones of any token collection, when you create a collection you select a category for it and then a template, this contains a set of pre-defined parameters that any one of your tokens will need in its metadata.

List all subcategories

When listing subcategories you have three scope options:

• generic: brings subcategories that are generic and are not for a specific company

• specific: lists only subcategories created by the company

• all: lists all of the above

get

List subcategories of a company

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

companyIdstringRequired

Query parameters

categoryIdstringOptional

scopestringOptionalExample: all

Responses

200Success

application/json

401

Need user with one of these roles: superAdmin, admin

get

HTTPcURLJavaScriptPython

GET /{companyId}/subcategories HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "companyId": "text",
    "category": {
      "id": "text",
      "companyId": "text",
      "subcategories": [
        {}
      ],
      "name": "text",
      "image": "text",
      "createdAt": "2025-09-20T12:26:35.719Z",
      "updatedAt": "2025-09-20T12:26:35.719Z"
    },
    "categoryId": "text",
    "name": "text",
    "tokenTemplate": {
      "prop1": {
        "type": "SELECT",
        "config": {
          "required": {},
          "label": "text",
          "tooltip": "text",
          "placeholder": "text",
          "order": 1,
          "childrenType": "SELECT",
          "range": {
            "min": 1,
            "max": 1
          },
          "options": [
            "text"
          ],
          "float": true
        },
        "children": {}
      },
      "prop2": {
        "type": "SELECT",
        "config": {
          "required": {},
          "label": "text",
          "tooltip": "text",
          "placeholder": "text",
          "order": 1,
          "childrenType": "SELECT",
          "range": {
            "min": 1,
            "max": 1
          },
          "options": [
            "text"
          ],
          "float": true
        },
        "children": {}
      }
    },
    "deletedAt": "2025-09-20T12:26:35.719Z",
    "createdAt": "2025-09-20T12:26:35.719Z",
    "updatedAt": "2025-09-20T12:26:35.719Z",
    "certificateTemplate": "text"
  }
]

Create a subcategory

post

Create a new subcategory

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

companyIdstringRequired

Body

application/json

categoryIdstringRequired

namestringRequired

tokenTemplateobjectRequired

certificateTemplatestringOptional

Responses

201Success

application/json

401

Need user with one of these roles: superAdmin, admin

post

HTTPcURLJavaScriptPython

POST /{companyId}/subcategories HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "categoryId": "text",
  "name": "text",
  "tokenTemplate": {},
  "certificateTemplate": "text"
}

{
  "id": "text",
  "companyId": "text",
  "category": {
    "id": "text",
    "companyId": "text",
    "subcategories": [
      {}
    ],
    "name": "text",
    "image": "text",
    "createdAt": "2025-09-20T12:26:35.719Z",
    "updatedAt": "2025-09-20T12:26:35.719Z"
  },
  "categoryId": "text",
  "name": "text",
  "tokenTemplate": {
    "prop1": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    },
    "prop2": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    }
  },
  "deletedAt": "2025-09-20T12:26:35.719Z",
  "createdAt": "2025-09-20T12:26:35.719Z",
  "updatedAt": "2025-09-20T12:26:35.719Z",
  "certificateTemplate": "text"
}

Get subcategory details

get

Get a subcategory by id

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

idstringRequired

companyIdstringRequired

Responses

200Success

application/json

401

Need user with one of these roles: superAdmin, admin

get

HTTPcURLJavaScriptPython

GET /{companyId}/subcategories/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "companyId": "text",
  "category": {
    "id": "text",
    "companyId": "text",
    "subcategories": [
      {}
    ],
    "name": "text",
    "image": "text",
    "createdAt": "2025-09-20T12:26:35.719Z",
    "updatedAt": "2025-09-20T12:26:35.719Z"
  },
  "categoryId": "text",
  "name": "text",
  "tokenTemplate": {
    "prop1": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    },
    "prop2": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    }
  },
  "deletedAt": "2025-09-20T12:26:35.719Z",
  "createdAt": "2025-09-20T12:26:35.719Z",
  "updatedAt": "2025-09-20T12:26:35.719Z",
  "certificateTemplate": "text"
}

Update subcategory

patch

Update a subcategory by id

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

idstringRequired

companyIdstringRequired

Body

application/json

categoryIdstringOptional

namestringOptional

tokenTemplateobjectOptional

certificateTemplatestringOptional

Responses

200Success

application/json

401

Need user with one of these roles: superAdmin, admin

patch

HTTPcURLJavaScriptPython

PATCH /{companyId}/subcategories/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "categoryId": "text",
  "name": "text",
  "tokenTemplate": {},
  "certificateTemplate": "text"
}

{
  "id": "text",
  "companyId": "text",
  "category": {
    "id": "text",
    "companyId": "text",
    "subcategories": [
      {}
    ],
    "name": "text",
    "image": "text",
    "createdAt": "2025-09-20T12:26:35.719Z",
    "updatedAt": "2025-09-20T12:26:35.719Z"
  },
  "categoryId": "text",
  "name": "text",
  "tokenTemplate": {
    "prop1": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    },
    "prop2": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    }
  },
  "deletedAt": "2025-09-20T12:26:35.719Z",
  "createdAt": "2025-09-20T12:26:35.719Z",
  "updatedAt": "2025-09-20T12:26:35.719Z",
  "certificateTemplate": "text"
}