> For the complete documentation index, see [llms.txt](https://knowledge.out-smart.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledge.out-smart.com/openapi/categories.md).

# Categories

## Get categories

> This api is used to categories with WorkorderApp.\
> Each category record can contain the following data:\
> \
> \| Parameter                 | Description                                   | Required | Type (size)   |\
> \|---------------------------|-----------------------------------------------|----------|---------------|\
> \| cat\_code                  | Category code                                 | Y        | Varchar (255) |\
> \| cat\_cat\_code              | Parent category code part                     | N        | Varchar (255) |\
> \| cat\_name                  | Category name                                 | Y        | Varchar (255) |\
> \| cat\_image                 | Url of the image. POST: An external url should be provided.  GET: You will receive a workorderapp url.     | N        | Varchar (255)      |\
> \| cat\_display               | Indication if the category should be displayed| Y        | Int (10)      |

```json
{"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/categories/":{"get":{"summary":"Get categories","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Response_200"}},"tags":["Categories"],"description":"This api is used to categories with WorkorderApp.\nEach category record can contain the following data:\n\n| Parameter                 | Description                                   | Required | Type (size)   |\n|---------------------------|-----------------------------------------------|----------|---------------|\n| cat_code                  | Category code                                 | Y        | Varchar (255) |\n| cat_cat_code              | Parent category code part                     | N        | Varchar (255) |\n| cat_name                  | Category name                                 | Y        | Varchar (255) |\n| cat_image                 | Url of the image. POST: An external url should be provided.  GET: You will receive a workorderapp url.     | N        | Varchar (255)      |\n| cat_display               | Indication if the category should be displayed| Y        | Int (10)      |"}}}}
```

## Add categories

> This api is used to categories with WorkorderApp.  \
> Each category record can contain the following data:\
> \
> \| Parameter | Description | Required | Type (size) |\
> \| --- | --- | --- | --- |\
> \| cat\_code | Category code | Y | Varchar (255) |\
> \| cat\_cat\_code | Parent category code part | N | Varchar (255) |\
> \| cat\_name | Category name | Y | Varchar (255) |\
> \| cat\_image | Url of the image. POST: An external url should be provided. GET: You will receive a workorderapp url. | N | Varchar (255) |\
> \| cat\_display | Indication if the category should be displayed | Y | Int (10) |

```json
{"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/categories/":{"post":{"summary":"Add categories","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Response_200"}},"tags":["Categories"],"description":"This api is used to categories with WorkorderApp.  \nEach category record can contain the following data:\n\n| Parameter | Description | Required | Type (size) |\n| --- | --- | --- | --- |\n| cat_code | Category code | Y | Varchar (255) |\n| cat_cat_code | Parent category code part | N | Varchar (255) |\n| cat_name | Category name | Y | Varchar (255) |\n| cat_image | Url of the image. POST: An external url should be provided. GET: You will receive a workorderapp url. | N | Varchar (255) |\n| cat_display | Indication if the category should be displayed | Y | Int (10) |"}}}}
```

## Get categories by filter

> This api is used to fetch category based on a filter. \
> Filters can be given by adding a key and values array to the URL.\
> Adding a single filter: \&key=key1\&value=value1\
> Adding multiple filters: \&key\[]=key1\&value\[]=value1\&key\[]=key2\&value\[]=value2

```json
{"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/openapi/8/category/":{"get":{"summary":"Get categories by filter","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}},{"name":"key","in":"query","schema":{"type":"string"}},{"name":"value","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Response_200"}},"tags":["Categories"],"description":"This api is used to fetch category based on a filter. \nFilters can be given by adding a key and values array to the URL.\nAdding a single filter: &key=key1&value=value1\nAdding multiple filters: &key[]=key1&value[]=value1&key[]=key2&value[]=value2"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://knowledge.out-smart.com/openapi/categories.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.