---
title: "Describe a task"
method: GET
path: "/tasks/{id}"
tags: ["tasks"]
---

# Describe a task

`GET /tasks/{id}`

Retrieve a task resource.

## Path parameters

- `id` string, required

## Response `200`

The call was successful.

- Task
  - `href` string — A reference to the task
  - `type` string — The type of task
  - `target` string — An object on which a referencing task operates
  - `parameters` object — The parameters used as input to a task
  - `created` string, date-time — Time that the task was created.
  - `started` string, date-time — Time that the task was started. This field will be null if the task has not started.
  - `completed` string, date-time — Time at which processing for a task completed, or null if not yet completed.
  - `updated` string, date-time — Time at which the task was last updated.
  - `state` 'pending' | 'running' | 'success' | 'failed' — The current state of the task. success and failed are final states.
  - `description` string — A description of the task
  - `message` string — This field may contain a message regarding the current state of the task or it may be null.
  - `result` union — The result of a task. Type is an object dependent on the task. Will not be set for tasks that do not compute results.
    - object
    - SearchResult — Results of a search task
      - `matches` object[]
        - `account` Account
          - `billing_service` union
            - unknown
            - object
              - …
          - `stratus_id` string, nullable — Identification for stratus accounts
          - `name` string — The name associated with an account.
          - `log_retention` AccountLogRetention[] — An array of account log retention configuration.
            - `type` 'events', required — Type of log retention
            - `online_days` integer — Number of online days
            - `archive_days` integer — Number of archive days
            - `online_space_allowance` integer — Allowance for online space
            - `archive_space_allowance` integer — Allowance for archive space
          - `href` string, required — A reference to an account
          - `id` string, required — Deprecated. A unique identifier for the account.
        - `subject` object — A matched object containing at a minimum an "href" attribute and any attributes that were searched

---

[API](https://skmtc.dev/webscale/apis/webscale-apis.md) · [All operations](https://skmtc.dev/webscale/apis/webscale-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/webscale/webscale-apis/revisions/c98d872b50cb/schema)