---
title: "Bulk get custom entities by ID"
method: GET
path: "/custom-entities:bulk-get"
tags: ["customEntities"]
---

# Bulk get custom entities by ID

`GET /custom-entities:bulk-get`

## Request

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

Bulk get custom entities by ID

## Query parameters

- `customEntityIds` string, required
- `returning` string

## Response `200`

OK

- CustomEntitiesList
  - `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

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