List all categories

GET https://api.tamio.com/v2/categories/list

Returns a paginated list of categories. Supports filtering by name, product, site, or specific category UUID. Can also return only root categories or exclude descendant categories from results.

Query Parameters

page integer

Page number for pagination (1-based).

per_page integer

Number of categories to return per page.

order string

Sort order for the results.

ascdesc

filter string

Search filter to match category names or descriptions.

category_id string

Filter by specific category UUID.

product_id string

Filter categories that contain this specific product.

site_id string

Filter categories by site/domain.

Responses

200 Categories retrieved successfully

Categories retrieved successfully

status integer

total_results integer

Total number of categories matching the query.

categories array of Category

id string

parent_id string

slug string

icon string

status boolean

object string

category

name string

created_at integer

Unix epoch (seconds).

asset_id string

children array of string

config object

Multilingual configuration keyed by language code (e.g. en, de, es).

number_of_subcategories integer

number_of_products integer

number_of_sites integer

path string

Hierarchical UUID path of ancestor categories.

label_path string

Hierarchical name path of ancestor categories.

image object

Public asset details for the category image.

public_url string

alt_text string

asset_id string

400 | Code | Description |

Code	Description
`1002`	Category, product, or site not found

401 Unauthorized – invalid or missing Bearer token

Retrieve a category

/categories/list

1 const response = await fetch("https://api.tamio.com/v2/categories/list", {
2   headers: {
3     "Authorization": "Bearer YOUR_API_KEY",
4     "Accept": "application/json"
5   }
6 });
7 const data = await response.json();

1 require "uri"
2 require "net/http"
3 
4 url = URI("https://api.tamio.com/v2/categories/list")
5 
6 https = Net::HTTP.new(url.host, url.port)
7 https.use_ssl = true
8 
9 request = Net::HTTP::Get.new(url)
10 request["Accept"] = "application/json"
11 request["Authorization"] = "Bearer YOUR_API_KEY"
12 
13 response = https.request(request)
14 puts response.read_body

Responses

{
  "status": 200,
  "total_results": 42,
  "categories": [
    {
      "id": "c3d4e5f6-a1b2-7890-cdef-1234567890ab",
      "parent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "slug": "electronics",
      "icon": "laptop",
      "status": true,
      "object": "category",
      "name": "Electronics",
      "created_at": 1709500800,
      "asset_id": "f0e1d2c3-b4a5-6789-0abc-def123456789",
      "children": [
        "d4e5f6a1-b2c3-7890-abcd-ef1234567890",
        "e5f6a1b2-c3d4-7890-abcd-ef1234567890"
      ],
      "config": {
        "en": {
          "title": "Electronics",
          "seo_title": "Buy Electronics Online",
          "description": "All electronic products",
          "seo_description": "Shop the best electronics at great prices",
          "slug": "electronics"
        },
        "de": {
          "title": "Elektronik",
          "seo_title": "Elektronik Online Kaufen",
          "description": "Alle elektronischen Produkte",
          "seo_description": "Die besten Elektronikprodukte zu günstigen Preisen",
          "slug": "elektronik"
        }
      },
      "number_of_subcategories": 3,
      "number_of_products": 50,
      "number_of_sites": 2,
      "path": "a1b2c3d4-e5f6-7890-abcd-ef1234567890/c3d4e5f6-a1b2-7890-cdef-1234567890ab",
      "label_path": "Electronics/Laptops",
      "image": {
        "public_url": "https://pub.ox31.com/uploads/12345/category-image.jpg",
        "alt_text": "Electronics category banner",
        "asset_id": "f0e1d2c3-b4a5-6789-0abc-def123456789"
      }
    }
  ]
}

1	const response = await fetch("https://api.tamio.com/v2/categories/list", {
2	headers: {
3	"Authorization": "Bearer YOUR_API_KEY",
4	"Accept": "application/json"
5	}
6	});
7	const data = await response.json();

1	require "uri"
2	require "net/http"
3
4	url = URI("https://api.tamio.com/v2/categories/list")
5
6	https = Net::HTTP.new(url.host, url.port)
7	https.use_ssl = true
8
9	request = Net::HTTP::Get.new(url)
10	request["Accept"] = "application/json"
11	request["Authorization"] = "Bearer YOUR_API_KEY"
12
13	response = https.request(request)
14	puts response.read_body