API endpoint reference

Tasks

Every tasks endpoint in the WorkBOS API: parameters, request and response shape, and curl, Node and Python samples generated from the spec.

GET/tasks

List tasks

Parameters
NameInTypeRequired
limitqueryintegerNo
offsetqueryintegerNo
Responses
StatusDescription
200OK
401Missing/invalid API key
Example request
curl -X GET "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/tasks?limit=20&offset=20" \
  -H "Authorization: Bearer YOUR_API_KEY"
POST/tasks

Create task

Request body (required)
FieldType
namestring
statusstring
prioritystring
project_idstring (uuid)
assignee_idstring (uuid)
due_datestring (date)
descriptionstring
Responses
StatusDescription
201OK
401Missing/invalid API key
403Read-only key
Example request
curl -X POST "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/tasks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","status":"string","priority":"string","project_id":"00000000-0000-0000-0000-000000000000","assignee_id":"00000000-0000-0000-0000-000000000000","due_date":"2026-01-01","description":"string"}'
GET/tasks/{id}

Get a task by id

Parameters
NameInTypeRequired
idpathstringYes
Responses
StatusDescription
200OK
401Missing/invalid API key
404Not found
Example request
curl -X GET "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/tasks/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"
PATCH/tasks/{id}

Update a task

Parameters
NameInTypeRequired
idpathstringYes
Request body (required)
FieldType
namestring
statusstring
prioritystring
project_idstring (uuid)
assignee_idstring (uuid)
due_datestring (date)
descriptionstring
Responses
StatusDescription
200OK
401Missing/invalid API key
403Read-only key
404Not found
Example request
curl -X PATCH "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/tasks/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","status":"string","priority":"string","project_id":"00000000-0000-0000-0000-000000000000","assignee_id":"00000000-0000-0000-0000-000000000000","due_date":"2026-01-01","description":"string"}'
DELETE/tasks/{id}

Delete a task

Parameters
NameInTypeRequired
idpathstringYes
Responses
StatusDescription
200OK
401Missing/invalid API key
403Read-only key
Example request
curl -X DELETE "https://dkjdtyzjdkumnpdyezbs.supabase.co/functions/v1/api-v1/tasks/REPLACE_WITH_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"