Retrieve a single task

GET /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{id}

Retrieve a single task

cURL

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{id} \
  --header 'Authorization: <api-key>'

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "recommended_action_result_id": "<string>",
  "brief_template_id": "<string>",
  "brief_body": "",
  "sort_order": 0,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Path Parameters

id · string<uuid> · required

Task identifier

organization_id · string<uuid> · required

Organization identifier

result_id · string<uuid> · required

Recommended action result identifier

workspace_id · string<uuid> · required

Workspace identifier

Response

200

application/json

Task detail

id · string · required

Task UUID

name · string · required

Short imperative task name

description · string · required

Briefing context for this task

recommended_action_result_id · string · required

Parent recommended action result UUID

brief_template_id · string | null

Brief template UUID (set by users)

brief_body · string · default: ""

Generated brief body

sort_order · integer · default: 0

Display order within the recommendation

created_at · string<date-time> | null

Creation timestamp