v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Async Tasks

Retrieve an 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.

get/async_tasks/{async_task}

Path parameters

async_taskstring required

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

The type of the object in Nmbr ("async_task").