tasks

Get a task

get/v1/tasks/{taskId}

Request

  • Base URL: https://api.flowral.app
  • URL: https://api.flowral.app/v1/tasks/{taskId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.flowral.app/v1/oauth/token, scopes: flows:read)

Path parameters

taskIdstring required

Response

SUCCESS

idstring required
flowIdstring required
parentIdstring nullable required

Set when this is a sub-task — the objective it belongs to. Null for an objective itself.

namestring required
descriptionstring nullable
status'blocked' | 'ready' | 'in_progress' | 'done' required

Derived from the graph on read, never stored. Work moves ready → in_progress → done; nothing jumps straight to done.

dependsOnstring[] required

Task ids that must be done first.

blockedBystring[]

Of those, the ones not yet done. Empty when status is not "blocked".

assigneeIdstring nullable
estimateHoursnumber nullable
criticalPathboolean

True when this task is on the chain that decides the flow's finish date.

Example response

{
  "id": "tsk_9f2c41"
}

Changes

No recorded changes to this operation across all 1 revision of this API.