> For the complete documentation index, see [llms.txt](https://docs.controlbee.nl/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.controlbee.nl/api/action-trackers.md).

# Action Trackers

API endpoints for managing action trackers

## GET /api/action-trackers

> List action trackers

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"tags":[{"name":"Action Trackers","description":"API endpoints for managing action trackers"}],"servers":[{"url":"https://{organisation}.controlbee.nl","description":"Your organisation's ControlBee environment","variables":{"organisation":{"default":"your-organisation","description":"The name in the address you use to log in to ControlBee"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Create an API token in ControlBee: click your profile picture, choose **Company management** and add a token under **API tokens** on the **General** page. Only users who are allowed to manage the company see this option. See [General and API](https://docs.controlbee.nl/en/profiel/bedrijfsbeheer/algemeen-en-api) in the manual. Send the token as `Authorization: Bearer <token>`."}},"schemas":{"ActionTracker":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"workflow":{"type":"string","enum":["new","in.progress","for.review","ready","retired"]},"assessment":{"type":["string","null"],"description":"Assessment details for the action tracker in HTML."},"analysis":{"type":["string","null"],"description":"Analysis details for the action tracker in HTML."},"solution":{"type":["string","null"],"description":"Proposed solutions for the action tracker in HTML."},"target_date":{"type":["string","null"],"format":"date"},"created_at":{"type":"string","format":"date-time"},"reporter":{"oneOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"assignee":{"oneOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"action_tracker_type":{"type":["string","null"]},"followers":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"labels":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"action_tracker_id":{"type":"integer"},"comment":{"type":"string"},"is_subcomment":{"type":"boolean"},"parent_comment_id":{"type":["integer","null"],"description":"ID of the parent comment if this is a subcomment. NOTE: field will not be present if is_subcomment is false."},"updated_at":{"type":"string","format":"date-time"}}}}}},"User":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"Pagination":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number"},"last_page":{"type":"integer","description":"Last available page number"},"per_page":{"type":"integer","description":"Number of items per page"},"from":{"type":"integer","description":"Index of the first item in the current page"},"to":{"type":"integer","description":"Index of the last item in the current page"},"total":{"type":"integer","description":"Total number of items available"},"links":{"type":"array","description":"Pagination links","items":{"type":"object","properties":{"url":{"type":["string","null"],"description":"URL for the page link"},"label":{"type":"string","description":"Label for the page link"},"page":{"type":["integer","null"],"description":"Page number for the link"},"active":{"type":"boolean","description":"Indicates if this link is for the current page"}}}}}}},"responses":{"UnauthorizedResponse":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"ForbiddenErrorResponse":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"NotFoundResponse":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"MethodNotAllowedResponse":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"InternalServerErrorResponse":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"paths":{"/api/action-trackers":{"get":{"summary":"List action trackers","operationId":"getActionTrackers","tags":["Action Trackers"],"parameters":[{"name":"page","in":"query","description":"Page number for pagination","required":false,"schema":{"type":"integer","default":1,"minimum":1}}],"responses":{"200":{"description":"Successful action trackers response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActionTracker"}},"meta":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"405":{"$ref":"#/components/responses/MethodNotAllowedResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"}}}}}}
```

## GET /api/action-trackers/{actionTrackerId}

> Get an action tracker

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"tags":[{"name":"Action Trackers","description":"API endpoints for managing action trackers"}],"servers":[{"url":"https://{organisation}.controlbee.nl","description":"Your organisation's ControlBee environment","variables":{"organisation":{"default":"your-organisation","description":"The name in the address you use to log in to ControlBee"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Create an API token in ControlBee: click your profile picture, choose **Company management** and add a token under **API tokens** on the **General** page. Only users who are allowed to manage the company see this option. See [General and API](https://docs.controlbee.nl/en/profiel/bedrijfsbeheer/algemeen-en-api) in the manual. Send the token as `Authorization: Bearer <token>`."}},"schemas":{"ActionTracker":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"workflow":{"type":"string","enum":["new","in.progress","for.review","ready","retired"]},"assessment":{"type":["string","null"],"description":"Assessment details for the action tracker in HTML."},"analysis":{"type":["string","null"],"description":"Analysis details for the action tracker in HTML."},"solution":{"type":["string","null"],"description":"Proposed solutions for the action tracker in HTML."},"target_date":{"type":["string","null"],"format":"date"},"created_at":{"type":"string","format":"date-time"},"reporter":{"oneOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"assignee":{"oneOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"action_tracker_type":{"type":["string","null"]},"followers":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"labels":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"action_tracker_id":{"type":"integer"},"comment":{"type":"string"},"is_subcomment":{"type":"boolean"},"parent_comment_id":{"type":["integer","null"],"description":"ID of the parent comment if this is a subcomment. NOTE: field will not be present if is_subcomment is false."},"updated_at":{"type":"string","format":"date-time"}}}}}},"User":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"}}}},"responses":{"UnauthorizedResponse":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"ForbiddenErrorResponse":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"NotFoundResponse":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"MethodNotAllowedResponse":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"InternalServerErrorResponse":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"paths":{"/api/action-trackers/{actionTrackerId}":{"get":{"summary":"Get an action tracker","operationId":"getActionTrackerById","tags":["Action Trackers"],"responses":{"200":{"description":"Successful action tracker response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ActionTracker"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"405":{"$ref":"#/components/responses/MethodNotAllowedResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"}}}}}}
```

## PUT /api/action-trackers/{actionTrackerId}

> Update an action tracker

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"tags":[{"name":"Action Trackers","description":"API endpoints for managing action trackers"}],"servers":[{"url":"https://{organisation}.controlbee.nl","description":"Your organisation's ControlBee environment","variables":{"organisation":{"default":"your-organisation","description":"The name in the address you use to log in to ControlBee"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Create an API token in ControlBee: click your profile picture, choose **Company management** and add a token under **API tokens** on the **General** page. Only users who are allowed to manage the company see this option. See [General and API](https://docs.controlbee.nl/en/profiel/bedrijfsbeheer/algemeen-en-api) in the manual. Send the token as `Authorization: Bearer <token>`."}},"schemas":{"UpdateActionTracker":{"type":"object","properties":{"name":{"type":"string","description":"The name of the action tracker."},"description":{"type":"string","description":"A detailed description of the action tracker."},"target_date":{"type":["string","null"],"format":"date","description":"The target date for the action tracker."},"workflow":{"type":["string","null"],"enum":["new","in.progress","for.review","ready","retired",null],"description":"Workflow status of the action tracker."},"analysis":{"type":["string","null"],"description":"Analysis related to the action tracker."},"solution":{"type":["string","null"],"description":"Proposed solution for the action tracker."},"assessment":{"type":["string","null"],"description":"Assessment details for the action tracker."},"reoccurring":{"type":["boolean","null"],"description":"Indicates if the action tracker is reoccurring."},"reoccurring_frequency":{"type":["string","null"],"enum":["monthly","quarterly","half-yearly","yearly","two-yearly",null],"description":"Frequency of reoccurrence for the action tracker."}}},"ActionTracker":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"workflow":{"type":"string","enum":["new","in.progress","for.review","ready","retired"]},"assessment":{"type":["string","null"],"description":"Assessment details for the action tracker in HTML."},"analysis":{"type":["string","null"],"description":"Analysis details for the action tracker in HTML."},"solution":{"type":["string","null"],"description":"Proposed solutions for the action tracker in HTML."},"target_date":{"type":["string","null"],"format":"date"},"created_at":{"type":"string","format":"date-time"},"reporter":{"oneOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"assignee":{"oneOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"action_tracker_type":{"type":["string","null"]},"followers":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"labels":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"action_tracker_id":{"type":"integer"},"comment":{"type":"string"},"is_subcomment":{"type":"boolean"},"parent_comment_id":{"type":["integer","null"],"description":"ID of the parent comment if this is a subcomment. NOTE: field will not be present if is_subcomment is false."},"updated_at":{"type":"string","format":"date-time"}}}}}},"User":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"}}}},"responses":{"UnauthorizedResponse":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"ForbiddenErrorResponse":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"NotFoundResponse":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"ValidationErrorResponse":{"description":"Unprocessable content. The request did not pass validation.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","description":"The validation messages per field.","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}},"InternalServerErrorResponse":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"paths":{"/api/action-trackers/{actionTrackerId}":{"put":{"summary":"Update an action tracker","operationId":"updateActionTracker","tags":["Action Trackers"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActionTracker"}}}},"responses":{"200":{"description":"Action tracker successfully updated response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ActionTracker"}}}}}},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/ValidationErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"}}}}}}
```

## Upload an action tracker image

> Uploads an image for use in action tracker content. The returned 'url' can be used as the 'src' of an image in the action tracker description. Uploaded images are stored per company and are only served to users of that company. Requires the 'action\_tracker.upload' permission.

```json
{"openapi":"3.1.0","info":{"title":"ControlBee API","version":"1.0.0"},"tags":[{"name":"Action Trackers","description":"API endpoints for managing action trackers"}],"servers":[{"url":"https://{organisation}.controlbee.nl","description":"Your organisation's ControlBee environment","variables":{"organisation":{"default":"your-organisation","description":"The name in the address you use to log in to ControlBee"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Create an API token in ControlBee: click your profile picture, choose **Company management** and add a token under **API tokens** on the **General** page. Only users who are allowed to manage the company see this option. See [General and API](https://docs.controlbee.nl/en/profiel/bedrijfsbeheer/algemeen-en-api) in the manual. Send the token as `Authorization: Bearer <token>`."}},"schemas":{"ImageUploadRequest":{"type":"object","required":["upload"],"properties":{"upload":{"type":"string","format":"binary","description":"The image to upload, sent as multipart/form-data. Accepted formats are jpeg, png, gif, bmp and webp; SVG is not accepted. The file may not be larger than 4096 kilobytes. The image is stored at a maximum width of 2048 pixels and a thumbnail of 300 pixels wide is generated alongside it."}}},"ImageUpload":{"type":"object","properties":{"url":{"type":"string","description":"The path the stored image is served from, relative to the tenant domain. Use this value as the 'src' of an image in content you send to ControlBee. The file name is generated on upload; the name of the uploaded file is not preserved."},"width":{"type":"integer","description":"The width of the stored image in pixels, after resizing."},"height":{"type":"integer","description":"The height of the stored image in pixels, after resizing."},"message":{"type":"string"}}}},"responses":{"UnauthorizedResponse":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"ForbiddenErrorResponse":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"MethodNotAllowedResponse":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"ValidationErrorResponse":{"description":"Unprocessable content. The request did not pass validation.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","description":"The validation messages per field.","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}},"InternalServerErrorResponse":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"paths":{"/api/action-trackers/upload":{"post":{"summary":"Upload an action tracker image","description":"Uploads an image for use in action tracker content. The returned 'url' can be used as the 'src' of an image in the action tracker description. Uploaded images are stored per company and are only served to users of that company. Requires the 'action_tracker.upload' permission.","operationId":"uploadActionTrackerImage","tags":["Action Trackers"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}}},"responses":{"200":{"description":"The image was stored. The 'url' is the path the image is served from.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUpload"}}}},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"},"405":{"$ref":"#/components/responses/MethodNotAllowedResponse"},"422":{"$ref":"#/components/responses/ValidationErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"}}}}}}
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.controlbee.nl/api/action-trackers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.