---
title: "Poll async task status"
method: GET
path: "/api/v3/tasks/box-schema/set-field-definitions/{task_id}"
tags: ["Box Schema"]
---

# Poll async task status

`GET /api/v3/tasks/box-schema/set-field-definitions/{task_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/tasks/box-schema/set-field-definitions/{task_id}`
- Auth: HTTP bearer

Poll the status of the "Set field definitions on a box schema" task.

Asynchronously set field definitions on a box schema. Requires permission to update settings on the schema's registry.

Include every existing field, including archived fields, in the desired order. Provide a field ID to update an existing field; omit the ID to create a new field. Omitted update attributes retain their existing values. To archive a field, set `archived` to `true` and provide `archiveReason`. Omitting a field does not delete it and causes validation to fail. Parent links and numeric ranges are not supported. Configured schema field limits apply, and the request fails if the schema has more items than the configured limit for re-syncing item field values.

## Path parameters

- `task_id` string, required

## Headers

- `EARLY-ACCESS` string

## Response `200`

OK

- BoxSchemaSetfielddefinitionsGetResponse200
  - `message` string, required
  - `result` SchemaSetFieldDefinitionsOutput: Return shape for the set_field_definitions API on schemas.
    - `fieldDefinitions` SchemaFieldDefinitionRef[]
      - `__typename` string
      - `id` string, api_id
    - `schemaId` string
  - `status` 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED', required

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

- **2026-11-05** `3873a10bf7b8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/benchling/apis/benchling-api/changes/api/v3/tasks/box-schema/set-field-definitions/:task_id/get.md)

---

[API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/3873a10bf7b8?raw)