ReferenceTo Do API

Lists & tasks

Lists, their members, and the tasks in them.

Method	Path	Summary
GET	`/v1/app/todo/lists`	List the caller's ToDo lists
POST	`/v1/app/todo/lists`	Create a list. Creator becomes the list's owner
PATCH	`/v1/app/todo/lists/:id`	Update a list's name, icon, color or position
DELETE	`/v1/app/todo/lists/:id`	Delete a list. Requires owner role on the list
GET	`/v1/app/todo/lists/:id/members`	List a list's owner and members
GET	`/v1/app/todo/lists/:id/available-users`	List tenant staff users not already on the list
POST	`/v1/app/todo/lists/:id/members`	Add a member to a list
PATCH	`/v1/app/todo/lists/:id/members/:userId`	Change a member's role
DELETE	`/v1/app/todo/lists/:id/members/:userId`	Remove a member from a list
GET	`/v1/app/todo/lists/:id/tasks`	List a list's (non-deleted) tasks
POST	`/v1/app/todo/lists/:id/tasks`	Add a task to a list
PATCH	`/v1/app/todo/lists/:id/tasks/:taskId`	Update a task's fields
PATCH	`/v1/app/todo/lists/:id/tasks/:taskId/move`	Move a task between status columns or reorder it within one
DELETE	`/v1/app/todo/lists/:id/tasks/:taskId`	Soft-delete a task. Requires editor or owner role on the list

#List the caller's ToDo lists

GET/v1/app/todo/lists

List the caller's ToDo lists. Returns lists the caller owns or is a member of (via todo_list_members), each annotated with my_role, task_count and open_count.

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Response 200

Field	Type	Description
`lists`	array of any

Example response

JSON

{
  "lists": []
}

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists' -Headers $headers

#Create a list. Creator becomes the list's owner

POST/v1/app/todo/lists

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Request body JSON

Name	Type	Description
`name`required	string
`icon`	any
`color`required	any

Response 201

Field	Type	Description
`list`	object
`list.my_role`	string

Example response

JSON

{
  "list": {
    "…rows[0]": "…",
    "my_role": "string"
  }
}

Errors

Status	Message
400	name is required
400	color must be a #rrggbb hex value

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example name","icon":"…","color":"…"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"Example name","icon":"…","color":"…"}),
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"name":"Example name","icon":"…","color":"…"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"name":"Example name","icon":"…","color":"…"}'
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists' -Headers $headers -ContentType 'application/json' -Body $body

#Update a list's name, icon, color or position

PATCH/v1/app/todo/lists/:id

Update a list's name, icon, color or position. Requires editor or owner role on the list (see todo_list_members).

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer

Request body JSON

Name	Type	Description
`name`	string
`icon`	any
`color`required	any
`position`	integer

Response 200

Field	Type	Description
`list`	array of any

Example response

JSON

{
  "list": []
}

Errors

Status	Message
400	color must be a #rrggbb hex value

Example request

Bash

curl -X PATCH 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example name","icon":"…","color":"…","position":1}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42', {
  method: 'PATCH',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"Example name","icon":"…","color":"…","position":1}),
});
const data = await res.json();

Python

import os, requests

r = requests.patch(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"name":"Example name","icon":"…","color":"…","position":1},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"name":"Example name","icon":"…","color":"…","position":1}'
Invoke-RestMethod -Method PATCH -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42' -Headers $headers -ContentType 'application/json' -Body $body

#Delete a list. Requires owner role on the list

DELETE/v1/app/todo/lists/:id

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

Bash

curl -X DELETE 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42', {
  method: 'DELETE',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.delete(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method DELETE -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42' -Headers $headers

#List a list's owner and members

GET/v1/app/todo/lists/:id/members

List a list's owner and members. Requires at least viewer role on the list.

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/members
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`owner`	any
`members`	array of any

Example response

JSON

{
  "owner": null,
  "members": []
}

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members' -Headers $headers

#List tenant staff users not already on the list

GET/v1/app/todo/lists/:id/available-users

List tenant staff users not already on the list. Requires editor or owner role on the list. Used to populate the "add member" picker.

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/available-users
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`users`	array of any

Example response

JSON

{
  "users": []
}

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/available-users' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/available-users', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/available-users",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/available-users' -Headers $headers

#Add a member to a list

POST/v1/app/todo/lists/:id/members

Add a member to a list. Requires editor or owner role on the list. Target user must be an active staff user in the caller's tenant.

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/members
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer

Request body JSON

Name	Type	Description
`user_id`required	integer
`role`	string: "viewer" \| "editor"

Response 201

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Errors

Status	Message
400	user_id is required
400	Invalid role
404	User not found in your organisation

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"user_id":7,"role":"viewer"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"user_id":7,"role":"viewer"}),
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"user_id":7,"role":"viewer"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"user_id":7,"role":"viewer"}'
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members' -Headers $headers -ContentType 'application/json' -Body $body

#Change a member's role

PATCH/v1/app/todo/lists/:id/members/:userId

Change a member's role. Requires owner role on the list.

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/members/:userId
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer
`userId`required	integer

Request body JSON

Name	Type	Description
`role`	string: "viewer" \| "editor"

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Errors

Status	Message
400	Invalid role

Example request

Bash

curl -X PATCH 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members/1' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"role":"viewer"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members/1', {
  method: 'PATCH',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"role":"viewer"}),
});
const data = await res.json();

Python

import os, requests

r = requests.patch(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members/1",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"role":"viewer"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"role":"viewer"}'
Invoke-RestMethod -Method PATCH -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members/1' -Headers $headers -ContentType 'application/json' -Body $body

#Remove a member from a list

DELETE/v1/app/todo/lists/:id/members/:userId

Remove a member from a list. A caller removing themselves only needs viewer role; removing another member requires owner role.

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/members/:userId
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer
`userId`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

Bash

curl -X DELETE 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members/1' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members/1', {
  method: 'DELETE',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.delete(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members/1",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method DELETE -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/members/1' -Headers $headers

#List a list's (non-deleted) tasks

GET/v1/app/todo/lists/:id/tasks

List a list's (non-deleted) tasks. Requires at least viewer role on the list.

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/tasks
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`tasks`	array of any

Example response

JSON

{
  "tasks": []
}

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks' -Headers $headers

#Add a task to a list

POST/v1/app/todo/lists/:id/tasks

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/tasks
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer

Request body JSON

Name	Type	Description
`title`required	string	What needs doing.
`notes`	array of any	More detail.
`status`	string	Its status.
`priority`	any	Its priority.
`due_date`	string (date)	When it's due (`YYYY-MM-DD`).
`recurrence`	any	How it repeats.

Response 201

Field	Type	Description
`task`	any

Example response

JSON

{
  "task": null
}

Errors

Status	Message
400	title is required
400	Invalid status
400	Invalid priority
400	Invalid recurrence

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Example title","notes":[],"status":"active","priority":"…","due_date":"2026-11-12","recurrence":"…"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"title":"Example title","notes":[],"status":"active","priority":"…","due_date":"2026-11-12","recurrence":"…"}),
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"title":"Example title","notes":[],"status":"active","priority":"…","due_date":"2026-11-12","recurrence":"…"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"title":"Example title","notes":[],"status":"active","priority":"…","due_date":"2026-11-12","recurrence":"…"}'
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks' -Headers $headers -ContentType 'application/json' -Body $body

#Update a task's fields

PATCH/v1/app/todo/lists/:id/tasks/:taskId

Update a task's fields. Requires editor or owner role on the list. Setting status to done also stamps completed_at; any other status clears it. At least one field must be provided.

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/tasks/:taskId
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer
`taskId`required	integer

Request body JSON

Name	Type	Description
`title`	string
`notes`	array of any
`status`	string
`priority`	any
`due_date`	string (date)
`recurrence`	any

Response 200

Field	Type	Description
`task`	any

Example response

JSON

{
  "task": null
}

Errors

Status	Message
400	Invalid status
400	Invalid priority
400	Invalid recurrence
400	No fields to update

Example request

Bash

curl -X PATCH 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Example title","notes":[],"status":"active","priority":"…","due_date":"2026-11-12","recurrence":"…"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1', {
  method: 'PATCH',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"title":"Example title","notes":[],"status":"active","priority":"…","due_date":"2026-11-12","recurrence":"…"}),
});
const data = await res.json();

Python

import os, requests

r = requests.patch(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"title":"Example title","notes":[],"status":"active","priority":"…","due_date":"2026-11-12","recurrence":"…"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"title":"Example title","notes":[],"status":"active","priority":"…","due_date":"2026-11-12","recurrence":"…"}'
Invoke-RestMethod -Method PATCH -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1' -Headers $headers -ContentType 'application/json' -Body $body

#Move a task between status columns or reorder it within one

PATCH/v1/app/todo/lists/:id/tasks/:taskId/move

Move a task between status columns or reorder it within one. Requires editor or owner role on the list. Used for drag-and-drop. Setting status to done also stamps completed_at; any other status clears it.

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/tasks/:taskId/move
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer
`taskId`required	integer

Request body JSON

Name	Type	Description
`status`	string
`position`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Errors

Status	Message
400	status and position are required

Example request

Bash

curl -X PATCH 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1/move' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"active","position":1}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1/move', {
  method: 'PATCH',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"status":"active","position":1}),
});
const data = await res.json();

Python

import os, requests

r = requests.patch(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1/move",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"status":"active","position":1},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"status":"active","position":1}'
Invoke-RestMethod -Method PATCH -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1/move' -Headers $headers -ContentType 'application/json' -Body $body

#Soft-delete a task. Requires editor or owner role on the list

DELETE/v1/app/todo/lists/:id/tasks/:taskId

Soft-delete a task. Requires editor or owner role on the list. Sets deleted_at rather than removing the row.

Address: https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/:id/tasks/:taskId
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: To Do.

Path parameters

Name	Type	Description
`id`required	integer
`taskId`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

Bash

curl -X DELETE 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1', {
  method: 'DELETE',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.delete(
    "https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method DELETE -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/todo/lists/42/tasks/1' -Headers $headers

Was this page helpful?