Category

Get Root Categories (Directories)

get

Retrieves the root (ROOT) categories by type.

Types

• FURNITURE : Furniture

• FURNITURE_SET : Furniture Set

• FINISH : Finish

• TEXTURE : Texture

• PROJECT : Project

• USER : User

• COMPONENT : Component

• PARAMETRIC_SALE : Parametric Product

• FILE : File

Authorizations

open-api-key

Query parameters

categoryTypestring · enumRequired

Category Type

Possible values:

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

get/api/v1/categories

HTTPcURLJavaScriptPython

GET /api/v1/categories?categoryType=FURNITURE HTTP/1.1
Host: openapi.archisketch.com
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Get Category

get

Retrieves category information and the subcategory list using the category ID.

Use Cases

• Retrieve detailed information of a specific category

• Check subcategory list

• Explore category hierarchy structure

Authorizations

open-api-key

Path parameters

idstringRequired

Category ID

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

get/api/v1/categories/{id}

HTTPcURLJavaScriptPython

GET /api/v1/categories/{id} HTTP/1.1
Host: openapi.archisketch.com
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content