BEbenchling
Study

Get Study by ID

Get a single Study by ID.

get/api/v3/study/{study_id}

Request

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

Path parameters

study_idstring required

ID of the Study.

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
archiveDatetimestring datetime nullable

No longer supported.

archiveReasonstring nullable
archivedboolean
authorsstring uri nullable

Users and apps designated as authors of the study.

createdAtstring datetime nullable
descriptionstring nullable
displayIdstring nullable

Human-readable identifier for the study. For schemas with auto-generated IDs, assigned by the server at creation. For MANUAL schemas, may be set at creation or update.

idstring
modifiedAtstring datetime nullable
namestring
phase'DESIGN' | 'EXECUTION' | 'COMPLETE'

Changes

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