W3Block Docs
  • 🚀Start here
    • Welcome to the Docs
    • Integrated Blockchains
  • 👨‍💻Dev Docs
    • API
      • Getting Started
      • Authentication
      • Commerce API services
        • Company Administration
          • Companies (Admin)
          • Assets (Admin)
          • Tags (Admin)
          • Products (Admin)
            • Order Rules (Admin)
          • Orders (Admin)
          • Faq (Admin)
          • Webhooks (Admin)
        • Products
        • Orders
        • Webhooks
        • Faq
        • Globals
      • Key API Services
        • Authentication
        • Companies
        • Tokens
          • Contracts
            • External Contacts
            • Royalty Eligible
          • Categories
            • Subcategories
          • Token Collections
            • Token Editions
          • Metadata
        • Blockchain
        • Cloudinary
        • Integration
          • Ecommerce
            • Associate Tokens
            • Hooks
        • Users
        • Vouchers
  • 📘Knowledge Base
    • First Steps
    • FAQ
    • Glossary
Powered by GitBook
On this page
  1. Dev Docs
  2. API
  3. Key API Services
  4. Tokens

Categories

Ths module can be used to retrieve categories to select specific templates when creating token collections

PreviousRoyalty EligibleNextSubcategories

Last updated 2 years ago

Categories are essential to create your own Token. A token can be anything you want: a piece of art, a ticket for a show a certificate for your antiquity... Categories are here to separate token templates so it is easier to find them all, all templates created fall under a category. Our API already has a set of generic categories for you but if you want a new category can be created for an specific company.

List Generic Categories

List all generic Categories

Create a Category for your Company

If you want a category that is not listed on the generics you can create your own category for your Company

List Categories by Company

List all Company Categories, this includes all categories you created plus all generic categories with a template that you created.

Update a Company Category

Get Category info

👨‍💻
get

Gets all existing NFT category

Authorizations
Responses
200Success
application/json
401
Need user with one of these roles: superAdmin, admin
get
GET /categories HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "companyId": "text",
    "subcategories": [
      {}
    ],
    "name": "text",
    "image": "text",
    "createdAt": "2025-06-01T15:03:53.281Z",
    "updatedAt": "2025-06-01T15:03:53.281Z"
  }
]
get

Gets an existing NFT category that matches the id

Authorizations
Path parameters
idstringRequired
companyIdstringRequired
Responses
200Success
application/json
401
Need user with one of these roles: superAdmin, admin
get
GET /{companyId}/categories/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-06-01T15:03:53.281Z",
  "updatedAt": "2025-06-01T15:03:53.281Z"
}
Deprecated
get

Gets an existing NFT category that matches the id

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
401
Need user with one of these roles: superAdmin, admin
get
GET /categories/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-06-01T15:03:53.281Z",
  "updatedAt": "2025-06-01T15:03:53.281Z"
}
  • List Generic Categories
  • GET/categories
  • Create a Category for your Company
  • POST/{companyId}/categories
  • List Categories by Company
  • GET/{companyId}/categories/{id}
  • Update a Company Category
  • PUT/{companyId}/categories/{id}
  • Get Category info
  • GET/categories/{id}
post

Create a new NFT category for a company

Authorizations
Path parameters
companyIdstringRequired
Body
namestringRequired
imagestringRequired
Responses
201Success
application/json
401
Need user with one of these roles: superAdmin, admin
post
POST /{companyId}/categories HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "image": "text"
}
{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-06-01T15:03:53.281Z",
  "updatedAt": "2025-06-01T15:03:53.281Z"
}
put

Updates an existing NFT category for a company

Authorizations
Path parameters
idstringRequired
companyIdstringRequired
Body
namestringOptional
imagestringOptional
Responses
200Success
application/json
401
Need user with one of these roles: superAdmin, admin
put
PUT /{companyId}/categories/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "image": "text"
}
{
  "id": "text",
  "companyId": "text",
  "subcategories": [
    {}
  ],
  "name": "text",
  "image": "text",
  "createdAt": "2025-06-01T15:03:53.281Z",
  "updatedAt": "2025-06-01T15:03:53.281Z"
}