Skip to main content

Retrieve a task from its ID

Abstract

Retrieve task details with the GET /tasks/{task_id} endpoint. Learn how to request a task using its ID to return status, assignment data, workflow context, and metadata so you can review its current state.

Use the GET /tasks/{task_id} endpoint to retrieve the full details of a single task when you already know its unique identifier. This endpoint returns the current state of the task, including status, assignment details, workflow context, and custom metadata.

Request

To retrieve a task based on its unique identifier, send a GET request to the /tasks/{task_id} endpoint. For example:

curl --request "GET" \ 
 "https://{api_region}/v5/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ 
 --header "apikey: YOUR_API_KEY"

Replace {api_region} with the domain from your region's base URL.

To authenticate your request, include the apikey: YOUR_API_KEY header. See Manage API keys for more information.

Response

A successful request returns the full task object. For example:

{
  "assessment_id": "9f60a03f-b3de-4b19-9361-0380d9aa1e9e",
  "assessment_template_id": "af8498c1-32bd-4453-b407-761eb6440e9b",
  "assignment": {
    "assigned_by_id": "22930149-1fab-4145-94b5-af2031b8de65",
    "assigned_to_id": "73c0fde6-eb34-47d5-8ccc-1b1d0aa325b6",
    "assigned_to_type": "USER",
    "assignment_comment": null
  },
  "c_name": "Review documentation",
  "created_at": "2019-08-24T14:15:22Z",
  "custom_metadata": null,
  "data_version": 0,
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "institution_id": "c75f2c73-5ae4-4f1c-99c0-fc726cd41798",
  "locked_at": "2019-08-24T14:15:22Z",
  "microfrontend_id": "f1ea2a19-6836-4b1f-824d-8a04dfae4cc7",
  "name": null,
  "status": "INCOMPLETE",
  "step_name": "Review",
  "updated_at": "2019-08-24T14:15:22Z",
  "workflow_instance_id": "46ff49d0-5f69-46b0-9de7-5703639a02ce"
}

Troubleshooting

  • If you receive a 401 Unauthorized response, make sure the apikey header is included and contains a valid key. Check that you are using the correct base URL for your region, and if IP allow listing is enabled, verify your request originates from an allowed IP address.

  • If you receive a 404 Task not found response, check that the task_id is valid.

For a full list of the possible error codes, view the API reference.

Additional information