---
title: "Get LocationSchema by ID"
method: GET
path: "/api/v3/location-schema/{location_schema_id}"
tags: ["Location Schema"]
---

# Get LocationSchema by ID

`GET /api/v3/location-schema/{location_schema_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/location-schema/{location_schema_id}`
- Auth: HTTP bearer

Get a single LocationSchema by ID.

## Path parameters

- `location_schema_id` string, required

## Query parameters

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

## Response `200`

OK

- LocationSchema: Defines the structure and metadata for a category of Locations in Benchling's inventory system. A LocationSchema specifies schema field definitions for capturing location-specific data (e.g., temperature range, access restrictions) and an optional Registry association with display ID prefix. LocationSchemas categorize different types of storage areas such as "Freezer", "Refrigerator", "Shelf", or "Room". Locations conforming to a schema inherit its field definitions, allowing consistent metadata capture across similar storage types.
  - `__typename` string
  - `archiveReason` string, nullable
  - `archived` boolean
  - `createdAt` string, datetime, nullable
  - `description` string: A description of the schema.
  - `fieldDefinitions` string, uri
  - `id` string
  - `modifiedAt` string, datetime, nullable
  - `name` string
  - `prefix` string, nullable
  - `registry` RegistryRef
    - `__typename` string
    - `id` string, api_id
  - `systemName` string: A unique, stable identifier for this schema used for programmatic access and integrations.
  - `type` string, nullable

## 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/c9f087b98b8b?raw)