BEbenchling
Entry

Get Entry by ID

Get a single Entry by ID.

get/api/v3/entry/{entry_id}

Request

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

Path parameters

entry_idstring required

ID of the Entry.

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.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Response

OK

__typenamestring
applicableReviewProcessesstring uri

Lists review processes configured for the entry's project. Use the paginated list of applicable review processes for the full list including stages and version details.

archiveReasonstring nullable

Specifies the archive reason when the entry is archived.

archivedboolean

Specifies whether the entry is archived.

createdAtstring datetime nullable

Specifies when the entry was created.

displayIdstring nullable

Specifies the display ID for the entry.

idstring

Identifies the entry.

modifiedAtstring datetime nullable

Specifies when the entry was last modified.

namestring nullable

Specifies the title of the entry.

webUrlstring

Specifies the absolute URL of the entry in the Benchling web app.

authorsstring uri nullable

Lists the authors of the entry. Defaults to the creator but may be edited.

partsstring uri

Lists ordered document parts that make up the document content.

Changes

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