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.

roots boolean

If true, return only root categories (no parent).

exclude_descendants boolean

If true, exclude descendant categories from results.

Responses

200 Categories retrieved successfully

Categories retrieved successfully

status integer

total_results integer

Total number of categories matching the query.

categories array of Category

400 Validation or business logic error. Returned when:

Validation or business logic error. Returned when:

page or per_page are not integers or out of range (1–100000 / 1–100)
order is not asc or desc
filter exceeds 120 characters
category_id, product_id, or site_id are not valid UUIDs
roots or exclude_descendants are not booleans
Unknown query parameters are sent

Error codes:

Code	Description
1002	Category, product, or site not found

status integer

error string

error_code integer

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": []
}

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