---
title: "List custom entities"
method: GET
path: "/custom-entities"
tags: ["customEntities"]
---

# List custom entities

`GET /custom-entities`

## Request

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

List custom entities

## Query parameters

- `nextToken` string
- `pageSize` integer
- `sort` 'createdAt' | 'createdAt:asc' | 'createdAt:desc' | 'modifiedAt' | 'modifiedAt:asc' | 'modifiedAt:desc' | 'name' | 'name:asc' | 'name:desc': Method by which to order search results. Valid sorts are name, modifiedAt, and createdAt. Optionally add :asc or :desc to specify ascending or descending order. Default is modifiedAt.
- `createdAt` string
- `modifiedAt` string
- `name` string
- `returning` string
- `nameIncludes` string
- `folderId` string
- `mentionedIn` string
- `projectId` string
- `registryId` string
- `schemaId` string
- `schemaFields` SchemaFieldsQueryParam
- `archiveReason` string
- `mentions` string
- `ids` string
- `names.anyOf` string
- `names.anyOf.caseSensitive` string
- `entityRegistryIds.anyOf` string
- `creatorIds` string
- `authorIds.anyOf` string

## Response `200`

OK

- CustomEntitiesPaginatedList
  - `customEntities` CustomEntity[]
    - `aliases` string[]
    - `apiURL` string, uri: The canonical url of the Custom Entity in the API.
    - `archiveRecord` ArchiveRecord
      - `reason` string
    - `authors` UserSummary[]
      - `handle` string
      - `id` string
      - `name` string
    - `createdAt` string, date-time
    - `creator` CustomEntityCreator
      - `handle` string
      - `id` string
      - `name` string
    - `customFields` CustomFields
    - `entityRegistryId` string, nullable
    - `fields` Fields
    - `folderId` string, nullable
    - `id` string
    - `modifiedAt` string, date-time
    - `name` string
    - `registrationOrigin` RegistrationOrigin
      - `originEntryId` string, nullable
      - `registeredAt` string, date-time
    - `registryId` string, nullable
    - `schema` SchemaSummary
      - `id` string
      - `name` string
    - `url` string: The path of the web URL, omitting the tenant domain
    - `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)