# What you can ask

Example questions for an AI assistant connected to plnnrly, per area, with the REST API operation each one uses.

Once an assistant is connected, you ask in your own words. The examples below show what it can do, per area of plnnrly. Next to each question is the operation the assistant calls, with a link to its page in the API reference, so you can see exactly what happens.

The assistant works as you, so it can only do what your role allows.

## My work

| You ask                                                     | The assistant uses                                                                                                                                                                                                                                                                                                                             |
| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Which work items are assigned to me and not done yet?"     | [GET /work-items](https://developers.plnnrly.com/en/docs/api/v2/work-items/list/) with `filter[assignee_id]=me` and `filter[resolved]=false`                                                                                                                                                                                                   |
| "Add a comment to ACM-12: waiting for the customer's copy." | [POST /work-items/{work_item}/comments](https://developers.plnnrly.com/en/docs/api/v2/work-items/comments/create/), with `ACM-12` as the work item                                                                                                                                                                                            |
| "Move ACM-12 to Done."                                      | [POST /work-items/{work_item}/actions/transition](https://developers.plnnrly.com/en/docs/api/v2/work-items/transition/), after it looks up the Done status with [GET /workflow-statuses](https://developers.plnnrly.com/en/docs/api/v2/workflow-statuses/list/). Only when your organisation uses sprints, which bring the workflow statuses. |

## Time

| You ask                                                                       | The assistant uses                                                                                                                                                                                                                                   |
| ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Log an hour and a half on the Website project for yesterday: design review." | [POST /worklogs](https://developers.plnnrly.com/en/docs/api/v2/worklogs/create/) with `minutes: 90`, after it finds the project with [GET /projects](https://developers.plnnrly.com/en/docs/api/v2/projects/list/)                                   |
| "How many hours did I log this week?"                                         | [GET /worklogs](https://developers.plnnrly.com/en/docs/api/v2/worklogs/list/) with a date range. It returns your own hours unless you name someone else.                                                                                             |
| "Start a timer on ACM-12."                                                    | [POST /timers](https://developers.plnnrly.com/en/docs/api/v2/timers/create/) with `timeable_type: work_item`, after it reads ACM-12 with [GET /work-items/{work_item}](https://developers.plnnrly.com/en/docs/api/v2/work-items/get/) to get its id |

## Planning

| You ask                                                                | The assistant uses                                                                                                                                        |
| ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "What is in my agenda next week?"                                      | [GET /events](https://developers.plnnrly.com/en/docs/api/v2/events/list/) with `filter[start][gte]` and `filter[start][lte]`. It returns your own events. |
| "Put a review of ACM-12 in my agenda on Thursday from 14:00 to 15:00." | [POST /events](https://developers.plnnrly.com/en/docs/api/v2/events/create/)                                                                              |

## Leave

| You ask                                               | The assistant uses                                                                                                   |
| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| "Who is away next week?"                              | [GET /absences](https://developers.plnnrly.com/en/docs/api/v2/absences/list/) with `filter[start]` and `filter[end]` |
| "Which days are we closed for the rest of this year?" | [GET /free-days](https://developers.plnnrly.com/en/docs/api/v2/free-days/list/) with `filter[date][gte]`             |

Absences need the **Manage absences** permission, and free days need **Manage company-wide free days**.

## Drive

| You ask                                                  | The assistant uses                                                                                                                                                                                                                                          |
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Add these meeting notes to the Kick-off Acme document." | [PATCH /drive-documents/{drive_document}](https://developers.plnnrly.com/en/docs/api/v2/drive-documents/update/) with `mode: append`, after it finds the document with [GET /drive-items](https://developers.plnnrly.com/en/docs/api/v2/drive-items/list/) |
| "Summarise the Kick-off Acme document."                  | [GET /drive-documents/{drive_document}](https://developers.plnnrly.com/en/docs/api/v2/drive-documents/get/)                                                                                                                                                |

With `mode: append`, the notes are added after the existing text and nothing already there changes.

## Customers

| You ask                              | The assistant uses                                                                                                                                                                                         |
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Who are the contacts at Acme?"      | [GET /customers](https://developers.plnnrly.com/en/docs/api/v2/customers/list/) to find Acme, then [GET /contacts](https://developers.plnnrly.com/en/docs/api/v2/contacts/list/) filtered on that customer |
| "Which projects do we run for Acme?" | [GET /projects](https://developers.plnnrly.com/en/docs/api/v2/projects/list/) with `filter[customer_id]`                                                                                                   |

## Billing

Only when your organisation uses billing.

| You ask                                           | The assistant uses                                                                                                                              |
| ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| "Which sales invoices for Acme are still drafts?" | [GET /sales-invoices](https://developers.plnnrly.com/en/docs/api/v2/sales-invoices/list/) with `filter[status]=draft` and `filter[customer_id]` |

## Sprints

Only when your projects run sprints.

| You ask                                         | The assistant uses                                                                                                                                                                                               |
| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Start the next sprint on the Website project." | [POST /sprints/{sprint}/actions/start](https://developers.plnnrly.com/en/docs/api/v2/sprints/start/), after it finds the sprint with [GET /sprints](https://developers.plnnrly.com/en/docs/api/v2/sprints/list/) |
| "What is still open in the current sprint?"     | [GET /work-items](https://developers.plnnrly.com/en/docs/api/v2/work-items/list/) with `filter[sprint_id]` and `filter[resolved]=false`                                                                          |

## Tips

- Use issue keys such as ACM-12. The assistant can use them in work item paths, and looks up the number itself where it needs one.
- Say "me" or "my". The assistant can filter on you without looking up your name.
- Name the project or the customer, so the assistant does not have to guess.
- Ask the assistant to show what it is going to change before it writes anything.
- For long lists, ask for fewer rows or a summary. Answers have a maximum size, and the assistant is told when a list was cut short.

## What it will not do

- Upload files, such as attachments or Drive files.
- Delete anything without your confirmation and your organisation's permission.
- Anything your role cannot do in plnnrly.

[Permissions and safety](https://developers.plnnrly.com/en/docs/mcp/permissions-and-safety/) explains how this works.
