List custom entities | Benchling Documentation

curl -G https://{tenant_name}.benchling.com/api/v2/custom-entities \
     -H "Authorization: Bearer <token>" \
     -d archiveReason=NOT_ARCHIVED \
     --data-urlencode "createdAt=> 2022-03-01 AND < 2022-04-01" \
     --data-urlencode "modifiedAt=> 2022-03-01 AND < 2022-04-01"

{
  "customEntities": [
    {
      "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"
    }
  ],
  "nextToken": "string"
}

List custom entities

Authentication

AuthorizationBearer

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

Query parameters

nextTokenstringOptional

pageSizeintegerOptional0-100Defaults to 50

sortenumOptionalDefaults to modifiedAt: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.

createdAtstringOptional

Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those created in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

modifiedAtstringOptional

Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

namestringOptional

Name of a custom entity. Restricts results to those with the specified name, alias, or entity registry ID.

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.

nameIncludesstringOptional

Name substring of a custom entity. Restricts results to those with names, aliases, or entity registry IDs that include the provided substring.

folderIdstringOptional

ID of a folder. Restricts results to those in the folder.

mentionedInstringOptional

Comma-separated list of entry IDs. Restricts results to custom entities mentioned in those entries.

projectIdstringOptional

ID of a project. Restricts results to those in the project.

registryIdstringOptional

ID of a registry. Restricts results to those registered in this registry. Specifying "null" returns unregistered items.

schemaIdstringOptional

ID of a schema. Restricts results to those of the specified schema.

schemaFieldsmap from strings to anyOptional

Filter based on schema field value (not display value). Restricts results to those with a field whose value matches the filter. For Integer, Float, and Date type fields, supports the >= and <= operators (but not < or >). If any schemaField filters are present, the schemaId param must also be present. Note that all operators must be separated from any values by a single space.

archiveReasonstringOptional

Archive reason. Restricts items to those with the specified archive reason. Use “NOT_ARCHIVED” to filter for unarchived custom entities. Use “ANY_ARCHIVED” to filter for archived custom entities regardless of reason. Use “ANY_ARCHIVED_OR_NOT_ARCHIVED” to return items for both archived and unarchived.

mentionsstringOptional

Comma-separated list of resource IDs. Restricts results to those that mention the given items in the description.

idsstringOptional

Comma-separated list of ids. Matches all of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.

names.anyOfstringOptional

Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, aliases, or entity registry IDs, case insensitive. Warning - this filter can be non-performant due to case insensitivity.

names.anyOf.caseSensitivestringOptional

Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, aliases, or entity registry IDs, case sensitive.

entityRegistryIds.anyOfstringOptional

Comma-separated list of entity registry IDs. Maximum of 100. Restricts results to those that match any of the specified registry IDs

creatorIdsstringOptional

Comma separated list of users IDs

authorIds.anyOfstringOptional

Comma separated list of user or app IDs. Maximum of 100.

Response headers

Result-Countinteger

The total number of items that match the given query

x-rate-limit-limitinteger

The number of allowed requests in the current rate-limit period

x-rate-limit-remaininginteger

The number of seconds remaining in the current rate-limit period

x-rate-limit-resetinteger

The number of seconds remaining in the current rate-limit period

Response

customEntitieslist of objectsOptional

nextTokenstringOptional

Errors

400

Bad Request Error