TODO for AI API

hexGrid

Endpoint

HexGrid listGrids

GET

https://api.todofor.ai/api/v1

/projects/{projectId}/hexgrids

List all hex grids in a project.

HexGrid listGrids › path Parameters

projectIdstring · required

HexGrid listGrids › Responses

Successful response

idstring · required
projectIdstring · required
namestring · required
createdAtnumber · required
updatedAtnumber · required

descriptionstring

HexGrid createGrid

POST

https://api.todofor.ai/api/v1

/projects/{projectId}/hexgrids

Create a new hex grid in a project.

HexGrid createGrid › path Parameters

projectIdstring · required

HexGrid createGrid › Request Body

projectIdstring · required
namestring · required

descriptionstring

HexGrid createGrid › Responses

Successful response

idstring · required
projectIdstring · required
namestring · required
createdAtnumber · required
updatedAtnumber · required

descriptionstring

HexGrid getGrid

GET

https://api.todofor.ai/api/v1

/hexgrids/{gridId}

Get a hex grid by ID.

HexGrid getGrid › path Parameters

gridIdstring · required

HexGrid getGrid › Responses

Successful response

idstring · required
projectIdstring · required
namestring · required
createdAtnumber · required
updatedAtnumber · required

descriptionstring

HexGrid updateGrid

PUT

https://api.todofor.ai/api/v1

/hexgrids/{gridId}

Update a hex grid.

HexGrid updateGrid › path Parameters

gridIdstring · required

HexGrid updateGrid › Request Body

gridIdstring · required

namestring
descriptionstring

HexGrid updateGrid › Responses

Successful response

idstring · required
projectIdstring · required
namestring · required
createdAtnumber · required
updatedAtnumber · required

descriptionstring

HexGrid deleteGrid

DELETE

https://api.todofor.ai/api/v1

/hexgrids/{gridId}

Delete a hex grid and all its tiles.

HexGrid deleteGrid › path Parameters

gridIdstring · required

HexGrid deleteGrid › Request Body

gridIdstring · required

HexGrid deleteGrid › Responses

Successful response

successboolean · required

HexGrid listTiles

GET

https://api.todofor.ai/api/v1

/hexgrids/{gridId}/tiles

List all tiles in a hex grid.

HexGrid listTiles › path Parameters

gridIdstring · required

HexGrid listTiles › Responses

Successful response

idstring · required
gridIdstring · required
qnumber · required
rnumber · required
createdAtnumber · required
updatedAtnumber · required

todoIdstring
labelstring
metadataobject
Construct a type with a set of properties K of type T

HexGrid createTile

POST

https://api.todofor.ai/api/v1

/hexgrids/{gridId}/tiles

Create a tile at coordinates (q, r).

HexGrid createTile › path Parameters

gridIdstring · required

HexGrid createTile › Request Body

gridIdstring · required
qnumber · required
rnumber · required

labelstring
metadataobject
Construct a type with a set of properties K of type T

HexGrid createTile › Responses

Successful response

idstring · required
gridIdstring · required
qnumber · required
rnumber · required
createdAtnumber · required
updatedAtnumber · required

todoIdstring
labelstring
metadataobject
Construct a type with a set of properties K of type T

HexGrid getTile

GET

https://api.todofor.ai/api/v1

/hexgrids/{gridId}/tiles/{q}/{r}

Get a tile at coordinates (q, r).

HexGrid getTile › path Parameters

gridIdstring · required
qstring · required
rstring · required

HexGrid getTile › Responses

Successful response

idstring · required
gridIdstring · required
qnumber · required
rnumber · required
createdAtnumber · required
updatedAtnumber · required

todoIdstring
labelstring
metadataobject
Construct a type with a set of properties K of type T

HexGrid updateTile

PUT

https://api.todofor.ai/api/v1

/hexgrids/{gridId}/tiles/{q}/{r}

Update a tile at coordinates (q, r).

HexGrid updateTile › path Parameters

gridIdstring · required
qstring · required
rstring · required

HexGrid updateTile › Request Body

gridIdstring · required
qnumber · required
rnumber · required

labelstring
metadataobject
Construct a type with a set of properties K of type T

HexGrid updateTile › Responses

Successful response

idstring · required
gridIdstring · required
qnumber · required
rnumber · required
createdAtnumber · required
updatedAtnumber · required

todoIdstring
labelstring
metadataobject
Construct a type with a set of properties K of type T

HexGrid deleteTile

DELETE

https://api.todofor.ai/api/v1

/hexgrids/{gridId}/tiles/{q}/{r}

Delete a tile at coordinates (q, r).

HexGrid deleteTile › path Parameters

gridIdstring · required
qstring · required
rstring · required

HexGrid deleteTile › Request Body

gridIdstring · required
qnumber · required
rnumber · required

HexGrid deleteTile › Responses

Successful response

successboolean · required

HexGrid moveTile

POST

https://api.todofor.ai/api/v1

/hexgrids/{gridId}/tiles/{q}/{r}/move

Move a tile to new coordinates.

HexGrid moveTile › path Parameters

gridIdstring · required
qstring · required
rstring · required

HexGrid moveTile › Request Body

gridIdstring · required
qnumber · required
rnumber · required
newQnumber · required
newRnumber · required

HexGrid moveTile › Responses

Successful response

idstring · required
gridIdstring · required
qnumber · required
rnumber · required
createdAtnumber · required
updatedAtnumber · required

todoIdstring
labelstring
metadataobject
Construct a type with a set of properties K of type T

HexGrid attachTodo

POST

https://api.todofor.ai/api/v1

/hexgrids/{gridId}/tiles/{q}/{r}/attach

Attach a todo to a tile.

HexGrid attachTodo › path Parameters

gridIdstring · required
qstring · required
rstring · required

HexGrid attachTodo › Request Body

gridIdstring · required
qnumber · required
rnumber · required
todoIdstring · required

HexGrid attachTodo › Responses

Successful response

idstring · required
gridIdstring · required
qnumber · required
rnumber · required
createdAtnumber · required
updatedAtnumber · required

todoIdstring
labelstring
metadataobject
Construct a type with a set of properties K of type T

HexGrid detachTodo

POST

https://api.todofor.ai/api/v1

/hexgrids/{gridId}/tiles/{q}/{r}/detach

Detach the todo from a tile.

HexGrid detachTodo › path Parameters

gridIdstring · required
qstring · required
rstring · required

HexGrid detachTodo › Request Body

gridIdstring · required
qnumber · required
rnumber · required

HexGrid detachTodo › Responses

Successful response

idstring · required
gridIdstring · required
qnumber · required
rnumber · required
createdAtnumber · required
updatedAtnumber · required

todoIdstring
labelstring
metadataobject
Construct a type with a set of properties K of type T

HexGrid swapTodos

POST

https://api.todofor.ai/api/v1

/hexgrids/{gridId}/tiles/swap

Swap todos between two tiles.

HexGrid swapTodos › path Parameters

gridIdstring · required

HexGrid swapTodos › Request Body

gridIdstring · required
q1number · required
r1number · required
q2number · required
r2number · required

HexGrid swapTodos › Responses

Successful response

successboolean · required

HexGrid seedDefaultGrid

POST

https://api.todofor.ai/api/v1

/projects/{projectId}/hexgrids/seed

Delete all grids and seed default Digital Presence grid with 22 tiles.

HexGrid seedDefaultGrid › path Parameters

projectIdstring · required

HexGrid seedDefaultGrid › Request Body

projectIdstring · required

HexGrid seedDefaultGrid › Responses

Successful response

successboolean · required

HexGrid findTilesByTodo

GET

https://api.todofor.ai/api/v1

/tiles/by-todo/{todoId}

Find all tiles associated with a todo across grids.

HexGrid findTilesByTodo › path Parameters

todoIdstring · required

HexGrid findTilesByTodo › Responses

Successful response

idstring · required
gridIdstring · required
qnumber · required
rnumber · required
createdAtnumber · required
updatedAtnumber · required

todoIdstring
labelstring
metadataobject
Construct a type with a set of properties K of type T

frontendHost meta