---
title: "Get WorkflowOutputSchema by ID"
method: GET
path: "/api/v3/workflow-output-schema/{workflow_output_schema_id}"
tags: ["Workflow Output Schema"]
---

# Get WorkflowOutputSchema by ID

`GET /api/v3/workflow-output-schema/{workflow_output_schema_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/workflow-output-schema/{workflow_output_schema_id}`
- Auth: HTTP bearer

Get a single WorkflowOutputSchema by ID.

## Path parameters

- `workflow_output_schema_id` string, required

## Query parameters

- `returning` string[]
- `omit` string[]

## Headers

- `EARLY-ACCESS` string

## Response `200`

OK

- WorkflowOutputSchema: Defines the structure of `WorkflowOutput` instances produced by tasks of a given `WorkflowTaskSchema`. Each output schema specifies `fieldDefinitions` for the data to be captured, an optional `prefix` for human-readable output IDs, and a `name` for identification. Output schemas belong to an `Organization` and are linked to their parent `workflowTaskSchema`. In flowcharts, output schemas can define data that flows between nodes.
  - `__typename` string
  - `archiveReason` string, nullable
  - `archived` boolean
  - `createdAt` string, datetime
  - `fieldDefinitions` string, uri
  - `id` string
  - `modifiedAt` string, datetime
  - `name` string
  - `organization` OrganizationRef
    - `__typename` string
    - `id` string, api_id
  - `prefix` string
  - `workflowTaskSchema` WorkflowTaskSchemaRef
    - `__typename` string
    - `id` string, api_id

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