---
title: "List locations"
method: GET
path: "/locations"
tags: ["locations"]
---

# List locations

`GET /locations`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2`
- URL: `https://{tenant_name}.benchling.com/api/v2/locations`
- Auth: HTTP bearer

List locations

## Query parameters

- `pageSize` integer
- `nextToken` string
- `sort` 'barcode' | 'modifiedAt' | 'name' | 'barcode:asc' | 'modifiedAt:asc' | 'name:asc' | 'barcode:desc' | 'modifiedAt:desc' | 'name:desc' | 'createdAt' | 'createdAt:asc' | 'createdAt:desc'
- `schemaId` string
- `schemaFields` SchemaFieldsQueryParam
- `createdAt` string
- `modifiedAt` string
- `name` string
- `nameIncludes` string
- `ancestorStorageId` string
- `archiveReason` string
- `ids` string
- `barcodes` string
- `names.anyOf` string
- `names.anyOf.caseSensitive` string
- `creatorIds` string

## Response `200`

OK

- LocationsPaginatedList
  - `locations` Location[]
    - `archiveRecord` ArchiveRecord
      - `reason` string
    - `availableCapacity` integer, nullable: The number of available positions in this location. Null if *totalCapacity* is not set.
    - `barcode` string
    - `createdAt` string
    - `creator` UserSummary
      - `handle` string
      - `id` string
      - `name` string
    - `fields` Fields
    - `id` string
    - `modifiedAt` string
    - `name` string
    - `occupiedCapacity` integer, nullable: The number of plates, boxes, and containers currently in this location. Null if *totalCapacity* is not set.
    - `parentStorageId` string, nullable
    - `schema` SchemaSummary
      - `id` string
      - `name` string
    - `totalCapacity` integer, nullable: The total capacity of this location (i.e. how many plates, boxes, and containers it can store). If null, capacity is not limited.
    - `webURL` string
  - `nextToken` string

## Other responses

- `400`: Bad Request

---

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