---
title: "Retrieve an async task"
method: GET
path: "/async_tasks/{async_task}"
tags: ["Async Tasks"]
---

# Retrieve an async task

`GET /async_tasks/{async_task}`

Endpoint to fetch an AsyncTask.

Async Tasks are created when a long-running process is initiated (e.g. form generation) and can be used to track the progress of that process and fetch the results once it is completed.

A task starts as `processing` and ends as either `completed` or `error`. The `async_task_completed` webhook fires on both, whether the work succeeded or failed, so use this endpoint to read `status` and, on `error`, any failure details in `results`. `completed_at` is only set when the task succeeded.

The following example is for a Form Generation task, but the response fields will differ depending on the specific AsyncTask instance requested.

## Path parameters

- `async_task` string, required

## Response `200`

OK

- object
  - `id` string — The unique identifier of the object in Nmbr.
  - `object` string — The type of the object in Nmbr (`"async_task"`).
  - `data` AsyncTask
    - `type` 'batch_delete' | 'batch_upsert' | 'bulk_create' | 'bulk_delete' | 'bulk_update' | 'form_generation' | 'scenario_seed'
    - `status` 'completed' | 'error' | 'processing'
    - `completed_at` string, dateTime, nullable
    - `results` object, nullable
    - `created_at` string, dateTime — The date and time the object was created in Nmbr.
    - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/revisions/c2532d856ea2/schema)
