BEbenchling
folders

List folders

List folders

get/folders

Request

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

Query parameters

nextTokenstring
pageSizeinteger
sort'createdAt' | 'createdAt:asc' | 'createdAt:desc' | 'modifiedAt' | 'name' | 'modifiedAt:asc' | 'name:asc' | 'modifiedAt:desc' | 'name:desc'

Method by which to order search results. Valid sorts are modifiedAt (modified time, most recent first) and name (folder name, alphabetical). Optionally add :asc or :desc to specify ascending or descending order.

archiveReasonstring

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

nameIncludesstring

Name substring of a folder. Restricts results to those with names that include the provided substring.

parentFolderIdstring

ID of a folder. Restricts results to those in the folder. Use "NO_PARENT" to filter for root folders.

projectIdstring

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

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.

namestring

Name of a folder. Restricts results to those with the specified name.

section'INVENTORY' | 'NOTEBOOK'

Deprecated - Folder types have been merged, however this will restrict to the pre-merge types.

Response

OK

nextTokenstring

Changes

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