Checklists

#List checklists

Address

https://<your-org>.brambleit.cloud/hr/api/checklists

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: HR.

Query parameters

Response 200

{
  "checklists": []
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/hr/api/checklists', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Open tasks that are the viewer's to do, across every checklist

Address

https://<your-org>.brambleit.cloud/hr/api/checklists/tasks/mine

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: HR.

Response 200

{
  "tasks": [
    {
      "id": 42,
      "tenant_id": 1,
      "checklist_id": 7,
      "title": "Example title",
      "details": "string",
      "assignee": "hr",
      "assignee_employee_id": 7,
      "done_at": "2026-11-12T09:30:00.000Z",
      "done_by": 1,
      "done_by_name": "Example done by name",
      "sort": 1,
      "employee_id": 7,
      "kind": "onboarding",
      "checklist_name": "Example checklist name",
      "employee_name": "Example employee name"
    }
  ]
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/hr/api/checklists/tasks/mine', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Checklist templates

Address

https://<your-org>.brambleit.cloud/hr/api/checklists/templates

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: HR.

Response 200

{
  "templates": [
    {
      "id": 42,
      "kind": "onboarding",
      "name": "Example name",
      "description": "string",
      "tasks": false
    }
  ]
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/hr/api/checklists/templates', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Get a checklist

Address

https://<your-org>.brambleit.cloud/hr/api/checklists/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: HR.

Path parameters

Response 200

{
  "checklist": [],
  "tasks": []
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/hr/api/checklists/12.5', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Start a checklist

Address

https://<your-org>.brambleit.cloud/hr/api/checklists

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: HR.

Request body JSON

Response 201

{
  "id": 42
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/hr/api/checklists', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"employee_id":7,"template_id":12.5,"anchor_date":"2026-11-12"}),
});
const data = await res.json();

#Add a task

Address

https://<your-org>.brambleit.cloud/hr/api/checklists/:id/tasks

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: HR.

Path parameters

Request body JSON

Response 201

{
  "ok": true
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/hr/api/checklists/42/tasks', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"title":"Example title","assignee":"…","details":"string","due_date":"2026-11-12"}),
});
const data = await res.json();

#Tick or untick a task

Address

https://<your-org>.brambleit.cloud/hr/api/checklists/tasks/:tid/toggle

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: HR.

Path parameters

Request body JSON

Response 200

{
  "ok": true,
  "complete": null
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/hr/api/checklists/tasks/12.5/toggle', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"done":false}),
});
const data = await res.json();

#Delete a task

Address

https://<your-org>.brambleit.cloud/hr/api/checklists/tasks/:tid

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: HR.

Path parameters

Response 200

{
  "ok": true
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/hr/api/checklists/tasks/12.5', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

#Cancel a checklist

Address

https://<your-org>.brambleit.cloud/hr/api/checklists/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: HR.

Path parameters

Response 200

{
  "ok": true
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/hr/api/checklists/42', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();