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

# Poll async task status

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

## Request

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

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

## Path parameters

- `task_id` string, required

## Response `200`

OK

- CustomEntitySchemaSetfielddefinitionsGetResponse200
  - `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

---

[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)