--- title: "List DocumentPart items" method: GET path: "/api/v3/entry/{entry_id}/parts/items" tags: ["Entry"] --- # List DocumentPart items `GET /api/v3/entry/{entry_id}/parts/items` ## Request - Base URL: `https://{tenant_name}.benchling.com` - URL: `https://{tenant_name}.benchling.com/api/v3/entry/{entry_id}/parts/items` - Auth: HTTP bearer List DocumentPart items. ## Path parameters - `entry_id` string, required ## Query parameters - `id.anyOf` string[] - `nextToken` string - `pageSize` integer ## Headers - `EARLY-ACCESS` string ## Response `200` OK - DocumentPartPaginatedList - `items` DocumentPart[] - union - object: Represents an analysis embedded in a document, created from an analysis template. The template is applied asynchronously after the part is created, so the analysis may not yet be populated when first read. - `__typename` string, required - `analysis` AnalysisRef - `__typename` string - `id` string, api_id - `analysisTemplate` AutomationTemplateRef - `__typename` string - `id` string, api_id - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `id` string: Identifies the document part. - `indentation` integer: Specifies the indentation level for this content within the document. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents an attachment within a document. Attachments store file metadata and provide a time-limited download URL when allowed by antivirus policy. - `__typename` string, required - `caption` Caption: A rich text caption attached to a piece of document content, such as a table or an attachment. - `__typename` string - `formats` TextFormat[] - `__typename` string - `backgroundColor` string, nullable: Specifies the background color applied to the character range, when set. - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `foregroundColor` string, nullable: Specifies the text color applied to the character range, when set. - `properties` TextFormatItems[]: Specifies the character style properties applied to the range: bold, italic, underline, strikethrough, subscript, superscript, and monospace. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `links` LinkSpan[] - `__typename` string - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `url` string: Specifies the URL of the hyperlink. - `mentions` Mention[] - `__typename` string - `itemId` string: Identifies the referenced Benchling item. - `position` integer: Specifies the zero-based insertion index within the plain-text body where this mention appears. Mentions do not occupy characters in the plain-text body for purposes of format range start and end positions. - `text` string - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `customWidth` integer, nullable: Specifies the custom display width in pixels, when set. - `download` DocumentAttachmentDownload: Provides a time-limited URL for downloading a document attachment. - `__typename` string - `expiresAt` string, datetime: Specifies when the download URL expires, in ISO 8601 format. - `url` string: Specifies the presigned URL to download the attachment. - `externalFileId` string: Identifies the external file record for this attachment. - `filename` string: Specifies the attachment filename. - `id` string: Identifies the document part. - `indentation` integer: Specifies the indentation level for this content within the document. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `scanStatus` 'PENDING' | 'NO_THREATS_FOUND' | 'THREATS_FOUND' | 'UNSUPPORTED' | 'ACCESS_DENIED' | 'FAILED' | 'NEVER_SCANNED': Specifies the current antivirus scan status of the attachment. Download availability is determined by whether download is null. - `size` integer: Specifies the attachment size in bytes. - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents a reserved attachment slot within a document. Placeholders do not reference an uploaded file yet. - `__typename` string, required - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `customWidth` integer, nullable: Specifies the custom display width in pixels, when set. - `id` string: Identifies the document part. - `indentation` integer: Specifies the indentation level for this content within the document. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents an embedded reference to another Benchling item within a document. Supported items include sequences, AA sequences, custom entities, oligo conjugates and duplexes, proteins, entries, protocols, and other basic folder items. - `__typename` string, required - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `embeddedItem` union - object: AaSequence variant - `__typename` string, required - `aliases` string[], nullable: Array of aliases - `aminoAcids` string: Amino acids of the AA sequence. - `annotations` string, uri: Annotations marking functional regions, domains, binding sites, post-translational modifications, or other features on the AA sequence. - `archiveReason` string, nullable - `archived` boolean - `createdAt` string, datetime, nullable: DateTime the AA sequence was created. - `customFields` CustomField[], nullable: Custom fields set on the AA sequence. - … - `entityRegistryId` string, nullable: The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered. - `folder` FolderRef - … - `id` string: ID of the AA sequence. - `modifiedAt` string, datetime, nullable: DateTime the AA sequence was last modified. - `name` string: Name of the item. - `project` ProjectRef - … - `registrationOrigin` RegistrationOrigin: Captures the provenance of an entity's registration into the registry. The `originEntry` links to the `DocumentLike` (typically an entry or notebook) from which the entity was registered, providing traceability back to the original experimental context. The `registeredAt` timestamp records when the registration occurred. This information helps scientists understand where registered entities came from and when they were added to the registry. - … - `registry` RegistryRef - … - `schema` EntitySchemaRef - … - `typedSchema` AaSequenceSchemaRef - … - `authors` string, uri, nullable - `creator` PrincipalRef - … - `schemaFields` SchemaFieldValue[], nullable - … - object: CustomEntity variant - `__typename` string, required - `aliases` string[], nullable - `archiveReason` string, nullable - `archived` boolean - `createdAt` string, datetime, nullable - `customFields` CustomField[], nullable - … - `entityRegistryId` string, nullable: The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered. - `folder` FolderRef - … - `id` string - `modifiedAt` string, datetime, nullable - `name` string, nullable: Name of the item. - `project` ProjectRef - … - `registrationOrigin` RegistrationOrigin: Captures the provenance of an entity's registration into the registry. The `originEntry` links to the `DocumentLike` (typically an entry or notebook) from which the entity was registered, providing traceability back to the original experimental context. The `registeredAt` timestamp records when the registration occurred. This information helps scientists understand where registered entities came from and when they were added to the registry. - … - `registry` RegistryRef - … - `schema` EntitySchemaRef - … - `typedSchema` CustomEntitySchemaRef - … - `authors` string, uri, nullable - `creator` PrincipalRef - … - `schemaFields` SchemaFieldValue[], nullable - … - object: DnaSequence variant - `__typename` string, required - `aliases` string[], nullable: Array of aliases - `annotations` string, uri: Annotations on the DNA sequence, not including translations or primers. Annotations on parts are not included. - `archiveReason` string, nullable - `archived` boolean - `bases` string: Bases of the forward strand of the DNA sequence. - `createdAt` string, datetime, nullable - `customFields` CustomField[]: Custom fields set on the DNA sequence. - … - `entityRegistryId` string, nullable: The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered. - `folder` FolderRef - … - `id` string - `isCircular` boolean: Whether the DNA sequence is circular or linear. - `modifiedAt` string, datetime, nullable - `name` string: Name of the item. - `nucleotideAlignments` string, uri: Nucleotide alignments that use this sequence as the reference sequence. For template alignments, this is the template sequence; for consensus alignments, this is the derived consensus sequence. - `parts` string, uri: Part features linking regions of this sequence to other nucleotide sequences. - `primers` string, uri: Primer bind features on the DNA sequence. Primers on parts are not included. - `project` ProjectRef - … - `registrationOrigin` RegistrationOrigin: Captures the provenance of an entity's registration into the registry. The `originEntry` links to the `DocumentLike` (typically an entry or notebook) from which the entity was registered, providing traceability back to the original experimental context. The `registeredAt` timestamp records when the registration occurred. This information helps scientists understand where registered entities came from and when they were added to the registry. - … - `registry` RegistryRef - … - `schema` EntitySchemaRef - … - `startIndex` integer: Starting index for the sequence residues of linear DNA sequences. Implicitly 1 for other sequence types. - `translations` string, uri: Translation annotations present on the DNA sequence. Translations may be one region or split across multiple regions. Translations on parts are not included. - `typedSchema` DnaSequenceSchemaRef - … - `authors` string, uri, nullable - `creator` PrincipalRef - … - `schemaFields` SchemaFieldValue[], nullable - … - object: Entry variant - `__typename` string, required - `applicableReviewProcesses` string, 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. - `archiveReason` string, nullable: Specifies the archive reason when the entry is archived. - `archived` boolean: Specifies whether the entry is archived. - `createdAt` string, datetime, nullable: Specifies when the entry was created. - `customFields` CustomField[], nullable: Lists custom field values on the entry. - … - `displayId` string, nullable: Specifies the display ID for the entry. - `folder` FolderRef - … - `id` string: Identifies the entry. - `modifiedAt` string, datetime, nullable: Specifies when the entry was last modified. - `name` string, nullable: Specifies the title of the entry. - `review` ReviewRef - … - `reviewSource` ProjectRef - … - `schema` EntrySchemaRef - … - `selectors` TableCellSelector[]: Lists dropdown selectors available to table cells in the document. - … - `typedSchema` EntrySchemaRef - … - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - … - `webUrl` string: Specifies the absolute URL of the entry in the Benchling web app. - `authors` string, uri, nullable: Lists the authors of the entry. Defaults to the creator but may be edited. - `creator` PrincipalRef - … - `parts` string, uri: Lists ordered document parts that make up the document content. - `schemaFields` SchemaFieldValue[], nullable: Lists values for fields defined by the entry schema. - … - object: OligoConjugate variant - `__typename` string, required - `aliases` string[], nullable - `archiveReason` string, nullable - `archived` boolean - `backbone` NucleotideSimplePolymer: Represents a nucleic acid strand (DNA or RNA) within a complex polymer structure. Contains the sequence residues and connections to other polymers. The entity field links to a corresponding DnaSequence, RnaSequence, DnaOligo, or RnaOligo. Used as the backbone component in OligoConjugate and as forward/reverse strands in OligoDuplex. - … - `canonicalHelm` string - `conjugates` ConjugateSimplePolymer[] - … - `createdAt` string, datetime - `customFields` CustomField[], nullable - … - `entityRegistryId` string, nullable: The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered. - `folder` FolderRef - … - `id` string - `modifiedAt` string, datetime - `name` string: Name of the item. - `originalHelm` string, nullable - `outOfSync` boolean - `outOfSyncReason` string, nullable - `project` ProjectRef - … - `registrationOrigin` RegistrationOrigin: Captures the provenance of an entity's registration into the registry. The `originEntry` links to the `DocumentLike` (typically an entry or notebook) from which the entity was registered, providing traceability back to the original experimental context. The `registeredAt` timestamp records when the registration occurred. This information helps scientists understand where registered entities came from and when they were added to the registry. - … - `registry` RegistryRef - … - `schema` EntitySchemaRef - … - `structure` OligoConjugateStructure: Contains the complete structural definition of an oligo conjugate, including its oligonucleotide backbone, conjugated molecules and peptides, and the connections between them. For each simple polymer, restricted read access on the linked entity affects `entity` only; structural fields on that polymer are still populated for the containing conjugate. - … - `typedSchema` OligoConjugateSchemaRef - … - `authors` string, uri, nullable - `creator` PrincipalRef - … - `schemaFields` SchemaFieldValue[], nullable - … - object: OligoDuplex variant - `__typename` string, required - `aliases` string[], nullable - `archiveReason` string, nullable - `archived` boolean - `canonicalHelm` string - `conjugates` ConjugateSimplePolymer[] - … - `createdAt` string, datetime - `customFields` CustomField[], nullable - … - `entityRegistryId` string, nullable: The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered. - `folder` FolderRef - … - `forwardOffset` integer, nullable - `forwardStrand` NucleotideSimplePolymer: Represents a nucleic acid strand (DNA or RNA) within a complex polymer structure. Contains the sequence residues and connections to other polymers. The entity field links to a corresponding DnaSequence, RnaSequence, DnaOligo, or RnaOligo. Used as the backbone component in OligoConjugate and as forward/reverse strands in OligoDuplex. - … - `id` string - `modifiedAt` string, datetime - `name` string: Name of the item. - `originalHelm` string, nullable - `outOfSync` boolean - `outOfSyncReason` string, nullable - `project` ProjectRef - … - `registrationOrigin` RegistrationOrigin: Captures the provenance of an entity's registration into the registry. The `originEntry` links to the `DocumentLike` (typically an entry or notebook) from which the entity was registered, providing traceability back to the original experimental context. The `registeredAt` timestamp records when the registration occurred. This information helps scientists understand where registered entities came from and when they were added to the registry. - … - `registry` RegistryRef - … - `reverseStrand` NucleotideSimplePolymer: Represents a nucleic acid strand (DNA or RNA) within a complex polymer structure. Contains the sequence residues and connections to other polymers. The entity field links to a corresponding DnaSequence, RnaSequence, DnaOligo, or RnaOligo. Used as the backbone component in OligoConjugate and as forward/reverse strands in OligoDuplex. - … - `schema` EntitySchemaRef - … - `structure` OligoDuplexStructure: Contains the complete structural definition of an oligo duplex, including its forward and reverse strands, any conjugated molecules and peptides, and the connections between them. For each simple polymer, restricted read access on the linked entity affects `entity` only; structural fields on that polymer are still populated for the containing duplex. - … - `typedSchema` OligoDuplexSchemaRef - … - `authors` string, uri, nullable - `creator` PrincipalRef - … - `schemaFields` SchemaFieldValue[], nullable - … - object: Protein variant - `__typename` string, required - `aliases` string[], nullable: Array of aliases - `archiveReason` string, nullable - `archived` boolean - `chains` ProteinChain[]: The chains and associated amino acid sequences on the protein. - … - `createdAt` string, datetime: DateTime the protein was created. - `customFields` CustomField[], nullable: Custom fields set on the protein. - … - `domains` ProteinDomain[]: The domains and associated amino acid sequences on the protein. - … - `entityRegistryId` string, nullable: The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered. - `folder` FolderRef - … - `format` ProteinFormatRef - … - `fullHistory` string, uri: `fullHistory` is a superset of `history` that also returns inactive versions that are not part of the current version history. Versions are returned in chronological order (oldest first). - `history` string, uri: Only the currently active version lineage, in chronological order (oldest first). If a change was made and then undone by resetting to an earlier version, the version recording that change is not relevant to the current state of the entity, so it is not included in this listing. - `id` string: ID of the protein. - `modifiedAt` string, datetime: DateTime the protein was last modified. - `name` string: Name of the item. - `outOfSync` boolean: Indicates if constituent domain or chain entities have changed since the protein was last updated. - `outOfSyncReason` string, nullable: Any additional information about why the protein is out of sync. - `project` ProjectRef - … - `registrationOrigin` RegistrationOrigin: Captures the provenance of an entity's registration into the registry. The `originEntry` links to the `DocumentLike` (typically an entry or notebook) from which the entity was registered, providing traceability back to the original experimental context. The `registeredAt` timestamp records when the registration occurred. This information helps scientists understand where registered entities came from and when they were added to the registry. - … - `registry` RegistryRef - … - `schema` EntitySchemaRef - … - `typedSchema` ProteinSchemaRef - … - `authors` string, uri, nullable - `creator` PrincipalRef - … - `schemaFields` SchemaFieldValue[], nullable: Values for schema-defined fields on this protein. - … - object: Represents an embedded Benchling item that cannot be fetched via the API. The identifier is retained so references persist when document content is copied between documents. - `__typename` string, required - `id` string: Identifies the embedded item. The identifier is retained for reference only; the item cannot be retrieved. - `id` string: Identifies the document part. - `indentation` integer: Specifies the indentation level for this content within the document. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents a code block within a document. Content is stored as plain text and displayed in a fixed-width format. - `__typename` string, required - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `id` string: Identifies the document part. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `text` string: Specifies the plain-text body. - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents a heading within a document. Headings organize content by level and may include rich text and indentation. - `__typename` string, required - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `formats` TextFormat[]: Lists inline styling applied to character ranges in the plain-text body. - `__typename` string - `backgroundColor` string, nullable: Specifies the background color applied to the character range, when set. - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `foregroundColor` string, nullable: Specifies the text color applied to the character range, when set. - `properties` TextFormatItems[]: Specifies the character style properties applied to the range: bold, italic, underline, strikethrough, subscript, superscript, and monospace. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `headerType` 'HEADER_1' | 'HEADER_2' | 'SUBHEADER_1': Specifies the heading level and style: level one, level two, or subheader. - `id` string: Identifies the document part. - `indentation` integer: Specifies the indentation level for this content within the document. - `links` LinkSpan[]: Lists hyperlinks applied to character ranges in the plain-text body. - `__typename` string - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `url` string: Specifies the URL of the hyperlink. - `mentions` Mention[]: Lists inline mentions of other Benchling items in the plain-text body. - `__typename` string - `itemId` string: Identifies the referenced Benchling item. - `position` integer: Specifies the zero-based insertion index within the plain-text body where this mention appears. Mentions do not occupy characters in the plain-text body for purposes of format range start and end positions. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `text` string: Specifies the plain-text body. Character indices in formats, links, and mentions refer to positions in this string. - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents an ordered grid of image attachments within a document. The grid controls indentation. Each image omits indentation. - `__typename` string, required - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `id` string: Identifies the document part. - `images` ImageGridAttachment[]: Lists the image attachments in display order. - `__typename` string - `caption` Caption: A rich text caption attached to a piece of document content, such as a table or an attachment. - `__typename` string - `formats` TextFormat[] - … - `links` LinkSpan[] - … - `mentions` Mention[] - … - `text` string - `customWidth` integer, nullable: Specifies the custom display width in pixels, when set. - `download` DocumentAttachmentDownload: Provides a time-limited URL for downloading a document attachment. - `__typename` string - `expiresAt` string, datetime: Specifies when the download URL expires, in ISO 8601 format. - `url` string: Specifies the presigned URL to download the attachment. - `externalFileId` string: Identifies the external file record for this attachment. - `filename` string: Specifies the attachment filename. - `scanStatus` 'PENDING' | 'NO_THREATS_FOUND' | 'THREATS_FOUND' | 'UNSUPPORTED' | 'ACCESS_DENIED' | 'FAILED' | 'NEVER_SCANNED': Specifies the current antivirus scan status of the attachment. Download availability is determined by whether download is null. - `size` integer: Specifies the attachment size in bytes. - `indentation` integer: Specifies the indentation level for this content within the document. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `name` string: Specifies the display name of the image grid. - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents a single list item within a document. List items combine a marker style with rich text and indentation for ordered, unordered, and checklist content. - `__typename` string, required - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `formats` TextFormat[]: Lists inline styling applied to character ranges in the plain-text body. - `__typename` string - `backgroundColor` string, nullable: Specifies the background color applied to the character range, when set. - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `foregroundColor` string, nullable: Specifies the text color applied to the character range, when set. - `properties` TextFormatItems[]: Specifies the character style properties applied to the range: bold, italic, underline, strikethrough, subscript, superscript, and monospace. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `id` string: Identifies the document part. - `indentation` integer: Specifies the indentation level for this content within the document. - `links` LinkSpan[]: Lists hyperlinks applied to character ranges in the plain-text body. - `__typename` string - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `url` string: Specifies the URL of the hyperlink. - `listType` 'BULLET' | 'NUMBER' | 'CHECKBOX_CHECKED' | 'CHECKBOX_UNCHECKED': Specifies the list marker style. - `mentions` Mention[]: Lists inline mentions of other Benchling items in the plain-text body. - `__typename` string - `itemId` string: Identifies the referenced Benchling item. - `position` integer: Specifies the zero-based insertion index within the plain-text body where this mention appears. Mentions do not occupy characters in the plain-text body for purposes of format range start and end positions. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `text` string: Specifies the plain-text body. Character indices in formats, links, and mentions refer to positions in this string. - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: A results structured table promoted to a first-class, individually-fetchable document part. Captures experimental data against a result schema and supports row submission workflows. - `__typename` string, required - `columnDefinitions` IStructuredTableColumnDefinition[] - union - object: Specifies a user-defined table column with no additional type-specific fields. - … - object: Specifies a table column whose value is derived from a lookup configuration. - … - object: Specifies a table column backed by a schema field definition. - … - object: Specifies a system-managed table column with a predefined purpose. - … - `createdAt` string, datetime - `id` string - `indentation` integer - `isEvaluated` boolean - `isSubmittable` boolean - `modifiedAt` string, datetime - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `name` string - `resultSchema` ResultSchemaRef - `__typename` string - `id` string, api_id - `rowCount` integer - `rows` string, uri - `submissionStatus` 'UNSUBMITTED' | 'SUBMITTED' | 'HAS_UNSUBMITTED_CHANGES' | 'UNEVALUATED' - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents an embedded reference to a laboratory automation run schema and, when present, its run instance. - `__typename` string, required - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `id` string: Identifies the document part. - `indentation` integer: Specifies the indentation level for this content within the document. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `runSchema` RunSchemaRef - `__typename` string - `id` string, api_id - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents a section that groups related document content within a document. - `__typename` string, required - `color` 'DEFAULT' | 'RED' | 'ORANGE' | 'YELLOW' | 'GREEN' | 'BLUE' | 'INDIGO' | 'VIOLET' | 'CONTRAST_GREY' | 'CONTRAST_RED' | 'CONTRAST_ORANGE' | 'CONTRAST_YELLOW' | 'CONTRAST_GREEN' | 'CONTRAST_BLUE' | 'CONTRAST_INDIGO' | 'CONTRAST_VIOLET': Specifies the highlight color for the section, when set. - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `date` string, date, nullable: Specifies the section date, when set. - `id` string: Identifies the document part. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `title` string, nullable: Specifies the section title, when set. - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents a paragraph of rich text within a document. Text may include inline styling, hyperlinks, and mentions of other Benchling items. - `__typename` string, required - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `formats` TextFormat[]: Lists inline styling applied to character ranges in the plain-text body. - `__typename` string - `backgroundColor` string, nullable: Specifies the background color applied to the character range, when set. - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `foregroundColor` string, nullable: Specifies the text color applied to the character range, when set. - `properties` TextFormatItems[]: Specifies the character style properties applied to the range: bold, italic, underline, strikethrough, subscript, superscript, and monospace. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `id` string: Identifies the document part. - `indentation` integer: Specifies the indentation level for this content within the document. - `links` LinkSpan[]: Lists hyperlinks applied to character ranges in the plain-text body. - `__typename` string - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `url` string: Specifies the URL of the hyperlink. - `mentions` Mention[]: Lists inline mentions of other Benchling items in the plain-text body. - `__typename` string - `itemId` string: Identifies the referenced Benchling item. - `position` integer: Specifies the zero-based insertion index within the plain-text body where this mention appears. Mentions do not occupy characters in the plain-text body for purposes of format range start and end positions. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `text` string: Specifies the plain-text body. Character indices in formats, links, and mentions refer to positions in this string. - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents a labeled fill-in text box within a document. Values may be submitted. - `__typename` string, required - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `formats` TextFormat[]: Lists inline styling applied to character ranges in the plain-text body. - `__typename` string - `backgroundColor` string, nullable: Specifies the background color applied to the character range, when set. - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `foregroundColor` string, nullable: Specifies the text color applied to the character range, when set. - `properties` TextFormatItems[]: Specifies the character style properties applied to the range: bold, italic, underline, strikethrough, subscript, superscript, and monospace. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `id` string: Identifies the document part. - `indentation` integer: Specifies the indentation level for this content within the document. - `isSubmittable` boolean: Specifies whether this content can be submitted in its current state. - `links` LinkSpan[]: Lists hyperlinks applied to character ranges in the plain-text body. - `__typename` string - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `url` string: Specifies the URL of the hyperlink. - `mentions` Mention[]: Lists inline mentions of other Benchling items in the plain-text body. - `__typename` string - `itemId` string: Identifies the referenced Benchling item. - `position` integer: Specifies the zero-based insertion index within the plain-text body where this mention appears. Mentions do not occupy characters in the plain-text body for purposes of format range start and end positions. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `name` string: Specifies the display label for the text box. - `submissionStatus` 'UNSUBMITTED' | 'SUBMITTED' | 'HAS_UNSUBMITTED_CHANGES' | 'UNEVALUATED': Specifies the submission status of this content: unsubmitted, submitted, or has unsubmitted changes. - `text` string: Specifies the plain-text body. Character indices in formats, links, and mentions refer to positions in this string. - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents a document part whose specific type is not yet available in the API at the requested stability. Only the fields shared by all document parts are returned. - `__typename` string, required - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `id` string: Identifies the document part. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents an unstructured table embedded within a notebook entry or other document. Unstructured tables use freeform cells without schema-backed columns. Cells may contain text, formulas with evaluated values, formatting, and merged regions. - `__typename` string, required - `caption` Caption: A rich text caption attached to a piece of document content, such as a table or an attachment. - `__typename` string - `formats` TextFormat[] - `__typename` string - `backgroundColor` string, nullable: Specifies the background color applied to the character range, when set. - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `foregroundColor` string, nullable: Specifies the text color applied to the character range, when set. - `properties` TextFormatItems[]: Specifies the character style properties applied to the range: bold, italic, underline, strikethrough, subscript, superscript, and monospace. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `links` LinkSpan[] - `__typename` string - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `url` string: Specifies the URL of the hyperlink. - `mentions` Mention[] - `__typename` string - `itemId` string: Identifies the referenced Benchling item. - `position` integer: Specifies the zero-based insertion index within the plain-text body where this mention appears. Mentions do not occupy characters in the plain-text body for purposes of format range start and end positions. - `text` string - `columnDefinitions` TableColumnDefinition[]: Lists column definitions for the table. - `__typename` string - `isLocked` boolean: Specifies whether the column width is locked against resizing. - `name` string: Specifies the column display name. - `width` integer, nullable: Specifies the column width in pixels. Defaults to 100 when unset. - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `id` string: Identifies the document part. - `indentation` integer: Specifies the indentation level for this content within the document. - `isEvaluated` boolean: Specifies whether formula evaluation has been applied to the table. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `name` string: Specifies the display name of the table. - `rowCount` integer: Specifies the number of rows in the table. - `rows` string, uri: Lists rows in the table, in row order. - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - object: Represents an unstructured table embedded within a notebook entry or other document, including row and cell data. Returned when a request's returning spec asks for the detail type. - `__typename` string, required - `caption` Caption: A rich text caption attached to a piece of document content, such as a table or an attachment. - `__typename` string - `formats` TextFormat[] - `__typename` string - `backgroundColor` string, nullable: Specifies the background color applied to the character range, when set. - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `foregroundColor` string, nullable: Specifies the text color applied to the character range, when set. - `properties` TextFormatItems[]: Specifies the character style properties applied to the range: bold, italic, underline, strikethrough, subscript, superscript, and monospace. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `links` LinkSpan[] - `__typename` string - `end` integer: Specifies the exclusive end index of the character range within the plain-text body. - `start` integer: Specifies the inclusive start index of the character range within the plain-text body. - `url` string: Specifies the URL of the hyperlink. - `mentions` Mention[] - `__typename` string - `itemId` string: Identifies the referenced Benchling item. - `position` integer: Specifies the zero-based insertion index within the plain-text body where this mention appears. Mentions do not occupy characters in the plain-text body for purposes of format range start and end positions. - `text` string - `columnDefinitions` TableColumnDefinition[]: Lists column definitions for the table. - `__typename` string - `isLocked` boolean: Specifies whether the column width is locked against resizing. - `name` string: Specifies the column display name. - `width` integer, nullable: Specifies the column width in pixels. Defaults to 100 when unset. - `createdAt` string, datetime: Timestamp inherited from the document content backing this part. For entry and document content, this can reflect when the containing document was created, not when the DocumentPart identifier was created. - `id` string: Identifies the document part. - `indentation` integer: Specifies the indentation level for this content within the document. - `isEvaluated` boolean: Specifies whether formula evaluation has been applied to the table. - `modifiedAt` string, datetime: Specifies when this document part was last modified. - `modifier` PrincipalRef - `__typename` string - `id` string, api_id - `name` string: Specifies the display name of the table. - `rowCount` integer: Specifies the number of rows in the table. - `rows` TableRow[]: Lists rows in the table, each containing an ordered array of cells. - `__typename` string - `cells` TableCell[]: Lists cells in the row in column order. - `__typename` string - `errors` CellError[]: Lists evaluation and validation errors present on the cell. Inspect the error type on each error to distinguish evaluation failures from validation failures. - … - `evaluationValue` union: Specifies typed cell values computed server-side by formula evaluation. Read-only in API responses. The union covers supported value types; unrecognized types are returned as UnsupportedCellEvaluationValue. - … - `format` TableCellFormat: Specifies formatting properties applied to an entire table cell. - … - `inputValue` union: Types of values that Benchling can interpret. - … - `mergeRange` TableMergeRange: Specifies the extent of a merged cell region, set on the anchor cell. - … - `mergeRangeParent` MergedCellAnchor: Specifies coordinates of the anchor cell for a cell within a merged region. - … - `selectorId` string, nullable: Specifies the dropdown selector identifier for this cell, when present. Match this value to selectorId on dropdown selectors defined on the document. - `rowIndex` integer: Specifies the row's absolute position within the table, zero-based. - `versionMetadata` DocumentLikeVersionMetadata: Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record. - `__typename` string - `createdAt` string, datetime, nullable: Specifies when this version was created. Versions are immutable; this is the time the parent document was last edited to produce this revision. - `versionId` string: Identifies this version of the document. - `nextToken` string, nullable ## Other responses - `400`: Bad Request - `403`: Forbidden - `404`: Not Found - `429`: Too Many Requests - `500`: Internal Server Error ## Changes - **2026-11-05** `3873a10bf7b8`: 1 breaking, 1 info - added `subschema #4, subschema #10, subschema #16` to the `items/items/` response property `oneOf` list for the response status `200` - removed `subschema #4, subschema #10, subschema #16` from the `items/items/` response property `oneOf` list for the response status `200` [Operation history](https://skmtc.dev/benchling/apis/benchling-api/changes/api/v3/entry/:entry_id/parts/items/get.md) --- [API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/3873a10bf7b8?raw)