Get a custom entity

GET

https://{tenant_name}.benchling.com/api/v2/custom-entities/:custom_entity_id

GET

/api/v2/custom-entities/:custom_entity_id

curl https://{tenant_name}.benchling.com/api/v2/custom-entities/custom_entity_id \
     -H "Authorization: Bearer <token>"

{
  "aliases": [
    "sBN000"
  ],
  "apiURL": "https://benchling.com/api/v2/custom-entities/bfi_xCUXNVyG",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "authors": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "createdAt": "2017-04-18T05:54:56.247545+00:00",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "customFields": {
    "Legacy ID": {
      "value": "STR100"
    }
  },
  "entityRegistryId": "sBN000",
  "fields": {},
  "folderId": "lib_R8KcsjhW",
  "id": "bfi_xCUXNVyG",
  "modifiedAt": "2017-04-18T05:55:48.685345+00:00",
  "name": "sBN000",
  "registrationOrigin": {
    "originEntryId": "string",
    "registeredAt": "2024-01-15T09:30:00Z"
  },
  "registryId": "src_NetYd96a",
  "schema": {
    "id": "ts_EM122lfJ",
    "name": "Strain"
  },
  "url": "string",
  "webURL": "https://benchling.com/benchling/f/R8KcsjhW-academic-registry/bfi-xCUXNVyG-sbn000/edit"
}

Get a custom entity

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

custom_entity_idstringRequired

Query parameters

returningstringOptional

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, ’*’. For more information, click here.

Response

aliaseslist of stringsOptional

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the Custom Entity in the API.

archiveRecordobject or nullOptional

authorslist of objectsOptional

createdAtdatetimeOptionalRead-only

creatorobjectOptional

customFieldsmap from strings to objectsOptional

entityRegistryIdstring or nullOptional

fieldsmap from strings to objectsOptional

folderIdstring or nullOptional

idstringOptional

modifiedAtdatetimeOptionalRead-only

namestringOptional

registrationOriginobject or nullOptional

registryIdstring or nullOptional

schemaobject or nullOptional

urlstringOptional

The path of the web URL, omitting the tenant domain

webURLstringOptionalRead-only

Errors

400

Bad Request Error