# API reference

> Every endpoint of the LifeButler API v1.

Base URL `https://api.lifebutler.io/v1` · [OpenAPI 3.1](/developers/openapi.json) · [Conventions](/developers/conventions)

## [Workspaces](/developers/reference/workspaces)

The workspaces a key may use, and their members.

| Endpoint | |
|---|---|
| [`GET /me`](/developers/reference/workspaces#who-am-i) | Who am I |
| [`GET /workspaces`](/developers/reference/workspaces#list-workspaces) | List workspaces |
| [`GET /workspaces/{workspaceId}`](/developers/reference/workspaces#get-a-workspace) | Get a workspace |
| [`GET /workspaces/{workspaceId}/members`](/developers/reference/workspaces#list-members) | List members |

## [Calendar](/developers/reference/calendar)

Appointments, including repeating ones.

| Endpoint | |
|---|---|
| [`GET /workspaces/{workspaceId}/events`](/developers/reference/calendar#list-appointments-in-a-time-range) | List appointments in a time range |
| [`POST /workspaces/{workspaceId}/events`](/developers/reference/calendar#create-an-appointment) | Create an appointment |
| [`GET /workspaces/{workspaceId}/events/{eventId}`](/developers/reference/calendar#get-an-appointment) | Get an appointment |
| [`PATCH /workspaces/{workspaceId}/events/{eventId}`](/developers/reference/calendar#change-an-appointment) | Change an appointment |
| [`DELETE /workspaces/{workspaceId}/events/{eventId}`](/developers/reference/calendar#delete-an-appointment) | Delete an appointment |

## [Tasks](/developers/reference/tasks)

To-dos with exact or fuzzy due dates, assignees and repetition.

| Endpoint | |
|---|---|
| [`GET /workspaces/{workspaceId}/tasks`](/developers/reference/tasks#list-tasks) | List tasks |
| [`POST /workspaces/{workspaceId}/tasks`](/developers/reference/tasks#create-a-task) | Create a task |
| [`GET /workspaces/{workspaceId}/tasks/{taskId}`](/developers/reference/tasks#get-a-task) | Get a task |
| [`PATCH /workspaces/{workspaceId}/tasks/{taskId}`](/developers/reference/tasks#change-a-task) | Change a task |
| [`DELETE /workspaces/{workspaceId}/tasks/{taskId}`](/developers/reference/tasks#delete-a-task) | Delete a task |
| [`POST /workspaces/{workspaceId}/tasks/{taskId}/complete`](/developers/reference/tasks#complete-a-task) | Complete a task |
| [`POST /workspaces/{workspaceId}/tasks/{taskId}/reopen`](/developers/reference/tasks#reopen-a-task) | Reopen a task |

## [Lists](/developers/reference/lists)

Shopping and to-do lists and their items.

| Endpoint | |
|---|---|
| [`GET /workspaces/{workspaceId}/lists`](/developers/reference/lists#list-lists) | List lists |
| [`POST /workspaces/{workspaceId}/lists`](/developers/reference/lists#create-a-list) | Create a list |
| [`PATCH /workspaces/{workspaceId}/lists/{listId}`](/developers/reference/lists#rename-a-list) | Rename a list |
| [`DELETE /workspaces/{workspaceId}/lists/{listId}`](/developers/reference/lists#delete-a-list) | Delete a list |
| [`GET /workspaces/{workspaceId}/lists/{listId}/items`](/developers/reference/lists#list-items) | List items |
| [`POST /workspaces/{workspaceId}/lists/{listId}/items`](/developers/reference/lists#add-items) | Add items |
| [`PATCH /workspaces/{workspaceId}/lists/{listId}/items/{itemId}`](/developers/reference/lists#change-or-tick-off-an-item) | Change or tick off an item |
| [`DELETE /workspaces/{workspaceId}/lists/{listId}/items/{itemId}`](/developers/reference/lists#remove-an-item) | Remove an item |

## [Documents](/developers/reference/documents)

Stored files with their AI analysis: search, upload, download.

| Endpoint | |
|---|---|
| [`GET /workspaces/{workspaceId}/documents`](/developers/reference/documents#list-and-search-documents) | List and search documents |
| [`POST /workspaces/{workspaceId}/documents`](/developers/reference/documents#upload-a-document) | Upload a document |
| [`GET /workspaces/{workspaceId}/documents/{documentId}`](/developers/reference/documents#get-a-document) | Get a document |
| [`PATCH /workspaces/{workspaceId}/documents/{documentId}`](/developers/reference/documents#change-a-document) | Change a document |
| [`DELETE /workspaces/{workspaceId}/documents/{documentId}`](/developers/reference/documents#delete-a-document) | Delete a document |
| [`GET /workspaces/{workspaceId}/documents/{documentId}/file`](/developers/reference/documents#download-the-file) | Download the file |
| [`POST /workspaces/{workspaceId}/documents/{documentId}/analyze`](/developers/reference/documents#analyse-a-document-with-ai) | Analyse a document with AI |

## [Search & Butler](/developers/reference/search-and-butler)

Smart search by meaning and the AI butler.

| Endpoint | |
|---|---|
| [`GET /workspaces/{workspaceId}/search`](/developers/reference/search-and-butler#smart-search) | Smart search |
| [`POST /workspaces/{workspaceId}/butler`](/developers/reference/search-and-butler#ask-the-butler) | Ask the butler |