---
title: "List EntitySchema items"
method: GET
path: "/api/v3/entity-schema/items"
tags: ["Entity Schema"]
---

# List EntitySchema items

`GET /api/v3/entity-schema/items`

## Request

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

List EntitySchema items.

## Query parameters

- `archiveReason.anyOf` string[]
- `archived.anyOf` boolean[]
- `createdAt.gt` string, datetime
- `createdAt.gte` string, datetime
- `createdAt.lt` string, datetime
- `createdAt.lte` string, datetime
- `id.anyOf` string[]
- `modifiedAt.gt` string, datetime
- `modifiedAt.gte` string, datetime
- `modifiedAt.lt` string, datetime
- `modifiedAt.lte` string, datetime
- `name.anyOf` string[]
- `name.anyOf.caseSensitive` string[]
- `nextToken` string
- `omit` string[]
- `pageSize` integer
- `returning` string[]
- `sort` 'createdAt:asc' | 'createdAt:desc' | 'modifiedAt:asc' | 'modifiedAt:desc'

## Headers

- `EARLY-ACCESS` string

## Response `200`

OK

- EntitySchemaPaginatedList
  - `items` EntitySchema[]
    - `__typename` string
    - `archiveReason` string, nullable: Reason the EntitySchema was archived
    - `archived` boolean: If the EntitySchema is archived
    - `availableRegistrationNamingOptions` EntitySchemaAvailableRegistrationNamingOptionsItems[]: Naming strategies allowed when registering entities of this schema
    - `constraint` Constraint: Defines uniqueness requirements for entities within a schema. Constraints ensure that registered entities have unique values across specified fields (see `fieldDefinitionNames`) or unique domain-specific properties (see `TypeSpecificConstraint`). The hasUniqueResidues field is a legacy indicator for sequence uniqueness.
      - `__typename` string
      - `fieldDefinitionNames` string[], nullable
      - `hasUniqueResidues` boolean, nullable
    - `containableType` 'NONE' | 'ENTITY' | 'BATCH'
    - `createdAt` string, datetime, nullable
    - `description` string
    - `fieldDefinitions` string, uri
    - `id` string
    - `modifiedAt` string, datetime: DateTime the Entity Schema was last modified
    - `name` string
    - `prefix` string
    - `registry` RegistryRef
      - `__typename` string
      - `id` string, api_id
    - `type` string
    - `validationRules` string, uri
  - `nextToken` 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)