Folder

Get Folder by ID

Get a single Folder by ID.

get/api/v3/folder/{folder_id}

Request

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

Path parameters

folder_idstring required

ID of the Folder.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
childrenstring uri

The folders directly nested under this folder.

createdAtstring datetime
descriptionstring nullable
idstring
modifiedAtstring datetime nullable
namestring nullable

Changes

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