Tasks

Tasks represent workflow items that can be assigned to users within a client account. Tasks support hierarchical organization through subtasks and integrate with the chat system for communication.

Endpoints

List Tasks

GET /api/v2/tasks

Retrieves a paginated list of tasks.

Query Parameters

Response

{
  "data": [
    {
      "id": 1,
      "title": "Review Q1 journal entries",
      "description": "Check all journal entries for Q1 2024",
      "status": "OPEN",
      "task_type": "review",
      "completed_at": null,
      "completion_summary": null,
      "client_account_id": 7,
      "assigned_to_id": 7,
      "provider_client_account_id": null,
      "parent_task_id": null,
      "relation_type": null,
      "relation_id": null,
      "thread_id": 42,
      "created_at": "2024-03-15T10:00:00Z",
      "updated_at": "2024-03-15T10:00:00Z",
      "created_by_id": 7,
      "updated_by_id": null
    }
  ],
  "meta": {
    "page": 1,
    "pages": 1,
    "per_page": 25,
    "records": 1
  }
}

Create Task

POST /api/v2/tasks

Creates a new task.

Request Body

Response

Returns the created task with status 201 Created.

Get Task

GET /api/v2/tasks/{id}

Retrieves a specific task by ID.

Response

Returns a single task object.

Update Task

PUT /api/v2/tasks/{id}

Updates an existing task.

Request Body

Same fields as Create Task. All fields are optional for updates.

Response

Returns the updated task.

Delete Task

DELETE /api/v2/tasks/{id}

Deletes a task and its associated chat channel.

Response

Returns 204 No Content on success.

Attributes

Relationships

Business Rules

1. Deleting a task also deletes its associated chat channel
2. Tasks can be organized hierarchically using parent_task_id
3. Each task automatically gets a chat thread for discussion

Error Responses

Related Resources

• Chat
• Users
• Client Accounts