Tasks
List Tasks
Section titled “List Tasks”GET /api/v1/tasksScope: tasks:read
Query Parameters
Section titled “Query Parameters”| Parameter | Type | Default | Description |
|---|---|---|---|
page | integer | 1 | Page number |
limit | integer | 50 | Results per page (1-100) |
status | string | — | Filter: open, in_progress, completed, cancelled |
assigned_to | UUID | — | Filter by assigned user |
contact_id | UUID | — | Filter by contact/lead |
due_before | ISO 8601 | — | Tasks due before this date |
sort_by | string | created_at | Sort: due_date, created_at, or priority |
sort_dir | string | desc | Direction: asc or desc |
Example
Section titled “Example”curl "https://api.brightlyai.app/api/v1/tasks?status=open&sort_by=due_date&sort_dir=asc" \ -H "Authorization: Bearer brk_your_key"Response
Section titled “Response”{ "data": [ { "id": "c3d4e5f6-...", "organization_id": "org-uuid-...", "contact_id": "a1b2c3d4-...", "title": "Follow up on estimate", "description": "Send updated pricing after site visit", "priority": "high", "status": "open", "due_date": "2026-05-12T17:00:00Z", "assigned_to_user_id": "user-uuid-...", "created_by_user_id": "user-uuid-...", "created_by_ai": false, "created_at": "2026-05-10T14:30:00Z", "updated_at": "2026-05-10T14:30:00Z" } ], "meta": { "page": 1, "limit": 50, "total": 12, "total_pages": 1 }}Get Task
Section titled “Get Task”GET /api/v1/tasks/:idScope: tasks:read
Create Task
Section titled “Create Task”POST /api/v1/tasksScope: tasks:write
Request Body
Section titled “Request Body”| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Task title (1-500 chars) |
description | string | No | Task description (max 5000 chars) |
priority | string | No | Default: medium. Options: low, medium, high, urgent |
status | string | No | Default: open. Options: open, in_progress, completed, cancelled |
due_date | ISO 8601 | No | Due date |
contact_id | UUID | No | Link to a contact/lead |
assigned_to_user_id | UUID | No | Assign to a team member |
Example
Section titled “Example”curl -X POST "https://api.brightlyai.app/api/v1/tasks" \ -H "Authorization: Bearer brk_your_key" \ -H "Content-Type: application/json" \ -d '{ "title": "Follow up on estimate", "priority": "high", "due_date": "2026-05-12T17:00:00Z", "contact_id": "a1b2c3d4-..." }'Update Task
Section titled “Update Task”PUT /api/v1/tasks/:idScope: tasks:write
All create fields accepted, all optional.
Delete Task
Section titled “Delete Task”DELETE /api/v1/tasks/:idScope: tasks:write