Finding a Category ID

A category ID (GUID) references a specific knowledge base category, including all translated versions of it. You can get category IDs from the URLs in your Wix Answers account's Categories page.

To find a category ID:

  1. Hover over the Knowledge Base icon and click Categories.
  2. Select the relevant category on the left. 
  3. The category ID appears in the URL following 'categories':
    For example: https://[your-subdomain-name].wixanswers.com/app/kb/categories/2cbc3ca3-9e77-45ef-a4a0-c37bdd66267d
Note:
To find a subcategory's ID, select the subcategory in step 2 above, then locate the ID at the end of the URL after the parent category's ID (view image below). 

Related Articles

Categories APIs

Articles are categorized using categories, subcategories, and labels. The categories API enables you to manage categories and subcategories. Articles and labels are manged by other APIs.You can create two levels of categories: the root level > categories > subcategories. A category can have subcategories, but these subcategories can not have subcategories of their own. A category can either have associated articles, or subcategories that have associated articles, but not both.Importing RecordsYou can contact Wix Answers to enable administrators to import categories in bulk.Get Category InformationGet List of Categories (User)GET https://<tenant_subdomain>.wixanswers.com/api/v1/categories?locale={locale}Get the list of categories for a specific language. Also see Get List of Categories (Agent). Authorization: None Content type: application/json; charset=utf-8. Accept: application/json. Response: List of Category objects.Request ParamsDescriptionTypeRequiredlocaleCategory languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://wix.wixanswers.com/api/v1/categories?locale=enGet List of Categories (Agent)GET https://<tenant_subdomain>.wixanswers.com/api/v1/categories/admin?locale={locale}Get the list of categories for a specific language. Unlike the user version (see Get List of Categories (User)), the included information includes extra details, such as the number of published and draft articles. Authorization: Requires agent authorization token and permission FETCH_CATEGORIES Content type: application/json; charset=utf-8 Accept: application/json Response: List of Category objectsRequest ParamsDescriptionTypeRequiredlocaleCategory languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://wix.wixanswers.com/api/v1/categories/admin?locale=enGet Category Information Using Category IDGET https://<tenant_subdomain>.wixanswers.com/api/v1/categories/{category GUID}?locale={locale}Get information about a category, given the category ID. Authorization: None Content type: application/json; charset=utf-8. Accept: application/json. Response: Category object.Request ParamsDescriptionTypeRequiredlocaleCategory languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://wix.wixanswers.com/api/v1/categories/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa?locale=enGet Category Information Using URITop-level category: GET https://<tenant_subdomain>.wixanswers.com/api/v1/categories/uri/{URI}?locale={locale}Subcategory: GET https://<tenant_subdomain>.wixanswers.com/api/v1/categories/uri/{category URI}/{subcategory URI}?locale={locale}Get information about a category, given the category URI and subcategory URI. A top-level category's URI is the last part of the URL when viewing the category. If you are getting a subcategory, the category and subcategory URIs are the last parts of the URL, separated by a "/",  when viewing the subcategory.In the above picture, the category URI is getting-started-2722145.In the above picture, the category URI is developers and the subcategory URI is overview.Authorization: NoneContent type: application/json; charset=utf-8.Accept: application/json.Response: Category object.Request ParamsDescriptionTypelocaleCategory languageTwo-letter country code string (for example: 'de')✓Request Example (subcategory):GET https://wix.wixanswers.com/api/v1/categories/uri/developers/overview?locale=enAdd CategoryAdd (Top-Level) CategoryPOST https://<tenant_subdomain>.wixanswers.com/api/v1/categoriesAdd a top-level category. The language used is the primary locale. Authorization: Requires agent authorization token and permission MANAGE_CATEGORIES Content type: application/json; charset=utf-8 Accept: application/json Response: Category objectPayload ParamsDescriptionTypeRequirednameCategory nameString✓positionCategory sort order in the UIInteger, 0 or higherdataStructure of:* iconKey (string): ID of Wix Answers stock image used to represent category* iconSrc (string): URL of custom category imageStructurePayload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/categories/ { "name":"Development" }Add SubcategoryPOST https://<tenant_subdomain>.wixanswers.com/api/v1/categories/{category GUID}Add a subcategory under the category specified in the URL path. You cannot add a subcategory under a subcategory. Authorization: Requires agent authorization token and permission MANAGE_CATEGORIES Content type: application/json; charset=utf-8 Accept: application/json Response: Category object The request params / payload are the same as the ones for adding a top-level category. The parent category is taken from the GUID in the path.Move a CategoryPUT https://<tenant_subdomain>.wixanswers.com/api/v1/categories/{category GUID}/parentMove a category to be a child of another category, or change a subcategory to a top-level category. If a category already has associated published articles, you cannot move a subcategory to that category. Authorization: Requires agent authorization token and permission MANAGE_CATEGORIES Content type: application/json; charset=utf-8 Accept: application/json Response:  Category objectPayload ParamsDescriptionTypeRequiredparentIdThe new parent.GUIDTo change the category to a top-level category, use  00000000-0000-0000-0000-000000000000 as the parent.✓Payload Example:PUT https://<tenant_subdomain>.wixanswers.com/api/v1/categories/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/parent { "parentId":"77bc8694-5ccf-436c-ab2b-543563a5f425" }Manage CategoriesUpdate CategoryPUT https://<tenant_subdomain>.wixanswers.com/api/v1/categories/{category GUID}Update a category. See Important Information about Updating Using the API. Authorization: Requires agent authorization token and permission MANAGE_CATEGORIES Content type: application/json; charset=utf-8 Accept: application/json Response: NonePayload ParamsDescriptionTypeRequirednameCategory nameStringlocaleCategory languageTwo-letter country code string (for example: 'de')✓positionCategory sort order in the UIInteger, 0 or higherdataStructure of:* iconKey (string): ID of Wix Answers stock image used to represent category* iconSrc (string): URL of custom category imageStructurePayload Example:PUT https://<tenant_subdomain>.wixanswers.com/api/v1/categories/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a { "locale":"en", "name":"Research" }Get Whether a Category is Associated with Any ArticlesGET https://<tenant_subdomain>.wixanswers.com/api/v1/categories/{category GUID}/isUsedGet whether a category has any subcategories or articles. The response is true or false. Authorization: Requires agent authorization token and permission FETCH_CATEGORIES Content type: application/json; charset=utf-8 Accept: application/json Response: BooleanRequest Example:GET https://wix.wixanswers.com/api/v1/categories/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/isUsedDelete CategoryDELETE https://<tenant_subdomain>.wixanswers.com/api/v1/categories/{category GUID}Delete a category. You cannot delete a category if it has any associated articles or subcategories. Authorization: Requires agent authorization token and permission MANAGE_CATEGORIES Content type: application/json; charset=utf-8 Accept: application/json Response: NoneRequest Example:DELETE https://wix.wixanswers.com/api/v1/categories/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3faRequest Example Using curl:curl -X DELETE https://wix.wixanswers.com/api/v1/categories/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json; charset=utf-8' -H 'Accept: application/json'Sort CategoriesPOST https://<tenant_subdomain>.wixanswers.com/api/v1/categories/sortSort display of categories according to the specified order. Authorization: Requires agent authorization token and permission MANAGE_CATEGORIES Content type: application/json; charset=utf-8 Accept: application/json Response: NonePayload ParamsDescriptionTypeRequiredparentIdThe category to sortGUIDTo sort the top-level categories, use  00000000-0000-0000-0000-000000000000 as the parent.✓idsList of categories/subcategories in the desired sort orderIf you include any ids that are not associated with the category, the operation fails. If you do not include one or more ids that are are associated with the category, the ones that you include are sorted in the specified order and appear before the other (not included) ids.List of GUIDs✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/categories/sort { "parentId":"00000000-0000-0000-0000-000000000000", "ids":["bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa", "e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a"] }Manage Category FollowersFollow a CategoryPOST https://<tenant_subdomain>.wixanswers.com/api/v1/categories/{category GUID}/followFollow a category as an agent. You are notified when a category changes, such as when an article is added to the category. Authorization: Requires agent authorization token for specific agent and permission FETCH_CATEGORIES Content type: application/json; charset=utf-8 Accept: application/json Response: NonePayload ParamsDescriptionTypeRequiredlocaleCategory languageTwo-letter country code string (for example: 'de')✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/categories/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/follow { "locale":"en" }Unfollow a CategoryDELETE https://<tenant_subdomain>.wixanswers.com/api/v1/categories/{category GUID}/follow?locale={locale}Unfollow a category as an agent. Authorization: Requires agent authorization token for specific agent and permission FETCH_CATEGORIES Content type: application/json; charset=utf-8 Accept: application/json Response: NoneRequest ParamsDescriptionTypeRequiredlocaleCategory languageTwo-letter country code string (for example: 'de')✓Get Whether You Are Following a CategoryGET https://<tenant_subdomain>.wixanswers.com/api/v1/categories/{category GUID}/follow?locale={locale}Get whether you are following a category. The response is true or false. Authorization: Requires agent authorization token for specific agent and permission FETCH_CATEGORIES Content type: application/json; charset=utf-8 Accept: application/json Response: BooleanRequest ParamsDescriptionTypeRequiredlocaleCategory languageTwo-letter country code string (for example: 'de')✓

5 min read

Finding an Article ID

An article ID (GUID) references a specific article, including all translated versions of an article. The ID is useful if you are linking from a product that is translated into many languages, and you need a way to keep track of all articles related to your product. Article IDs are necessary when working with article APIs.To find an article ID: Go to the live URL of the relevant article. Click the Toolbar Expand Tab at the top left. Note: To see this option, make sure you are logged in as a team member. Click Manage this article in the Team Member Toolbar. The article ID appears in the article URL following 'article': For example: https://[your-subdomain-name].wixanswers.com/app/hc/article/article-id/

1 min read