molecules

List Molecules

List molecules

get/molecules

Request

  • Base URL
    https://{tenant_name}.benchling.com/api/v2
  • Auth
    HTTP bearer

Query parameters

pageSizeinteger

Number of results to return. Defaults to 50, maximum of 100.

nextTokenstring

Token for pagination

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.

createdAtstring

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.

modifiedAtstring

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.

namestring

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

nameIncludesstring

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

folderIdstring

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

mentionedInstring[]

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

projectIdstring

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

registryIdstring

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

schemaIdstring

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

schemaFieldsSchemaFieldsQueryParam

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.

archiveReasonstring

Archive reason. Restricts results to those with the specified archive reason. Use "NOT_ARCHIVED" to filter for unarchived Molecules. Use "ANY_ARCHIVED" to filter for archived Molecules regardless of reason. Use "ANY_ARCHIVED_OR_NOT_ARCHIVED" to return items for both archived and unarchived.

mentionsstring[]

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

idsstring

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.

entityRegistryIds.anyOfstring

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

names.anyOfstring

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

authorIds.anyOfstring

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

chemicalSubstructure.molstring

mol-formatted string for a chemical substructure to search by. Substructure queries using wildcard (any-atom) atoms need a connected group of at least 3 non-wildcard atoms, wildcard atoms can make up at most 50% of the query, and the query must have at least one bond between two atoms; requests that don't meet these constraints are rejected with a 400 response.

chemicalSubstructure.smilesstring

SMILES string for a chemical substructure to search by. Substructure queries using wildcard (any-atom) atoms need a connected group of at least 3 non-wildcard atoms, wildcard atoms can make up at most 50% of the query, and the query must have at least one bond between two atoms; requests that don't meet these constraints are rejected with a 400 response.

Response

OK

nextTokenstring

Changes

No recorded changes to this operation across all 1 revision of this API.