--- title: "Get a notebook template entry by ID" method: GET path: "/entry-templates/{entry_template_id}" tags: ["entries"] --- # Get a notebook template entry by ID `GET /entry-templates/{entry_template_id}` ## Request - Base URL: `https://{tenant_name}.benchling.com/api/v2-beta` - URL: `https://{tenant_name}.benchling.com/api/v2-beta/entry-templates/{entry_template_id}` - Auth: HTTP bearer Get a notebook template entry by ID ## Path parameters - `entry_template_id` string, required ## Response `200` Returns a single entry template. Entry templates are templates that users can base new notebook entries off of. - EntryTemplate: Entry templates are templates that users can base new notebook entries off of. - `apiURL` string, uri: The canonical url of the Entry Template in the API. - `createdAt` string, date-time: DateTime the template was created at - `creator` UserSummary - `handle` string - `id` string - `name` string - `customFields` CustomFields - `days` EntryTemplateDay[]: Array of day objects. Each day object has a day index (integer) and notes field (array of notes, expand further for details on note types). - `day` integer: 1 indexed day signifier. If 0 is returned, that means the EntryTemplateDay is a section with a title but no specified Day. - `notes` EntryTemplateDayNotesItems[] - union: Notes are the main building blocks of entries. Each note corresponds roughly to a paragraph. - SimpleNotePart: Simple note parts include the following types: - 'text': plain text - 'code': preformatted code block - 'list_bullet': one "line" of a bulleted list - 'list_number': one "line" of a numbered list - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `type` 'text' | 'code' | 'list_bullet' | 'list_number': The type of the note. Type determines what other fields are present. - `links` EntryLink[]: Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `text` string: The textual contents of the note. - TableNotePart: A table with rows and columns of text - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `type` 'table': The type of the note. Type determines what other fields are present. - `links` EntryLink[]: Array of links referenced in the caption via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `table` EntryTable: Actual tabular data with rows and columns of text on the note. - `columnLabels` string[]: Array of strings, with one item per column. Defaults to null, if the user is using the default, but is set if the user has given a custom name to the column. - `name` string: Name of the table - defaults to e.g. Table1 but can be renamed. - `rows` EntryTableRow[]: Array of row objects. - … - `text` string: The caption of the table. - TextBoxNotePart - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `type` 'text_box': The type of the note. Type determines what other fields are present. - `links` EntryLink[]: Array of links referenced via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `name` string - `text` string - CheckboxNotePart: One "line" of a checklist - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `type` 'list_checkbox': The type of the note. Type determines what other fields are present. - `checked` boolean: Indicates whether the checkbox is checked or not. - `links` EntryLink[]: Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `text` string: The textual contents of the note. - ExternalFileNotePart: An attached user-uploaded file - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `type` 'external_file': The type of the note. Type determines what other fields are present. - `externalFileId` string: The ID of the external file. Use the 'Get an external file' endpoint to retrieve metadata about it. - `links` EntryLink[]: Array of links referenced in the caption via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - `id` string: For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types. - `type` 'link' | 'user' | 'request' | 'entry' | 'stage_entry' | 'protocol' | 'workflow' | 'custom_entity' | 'aa_sequence' | 'dna_sequence' | 'batch' | 'box' | 'container' | 'location' | 'plate' | 'insights_dashboard' | 'folder' | 'sql_dashboard': The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'. - `webURL` string, nullable: Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently have a URL. - `text` string: The caption of the file attachment. - AssayRunNotePart - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `type` 'assay_run': The type of the note. Type determines what other fields are present. - `assayRunId` string, nullable - `assayRunSchemaId` string - LookupTableNotePart - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnProvenanceUUID` string - `isReadOnly` boolean - `name` string - `name` string - `type` 'lookup_table' - ResultsTableNotePart - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `type` 'results_table': The type of the note. Type determines what other fields are present. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnProvenanceUUID` string - `isReadOnly` boolean - `name` string - `name` string - `assayResultSchemaId` string - RegistrationTableNotePart - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `type` 'registration_table': The type of the note. Type determines what other fields are present. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnProvenanceUUID` string - `isReadOnly` boolean - `name` string - `name` string - `entitySchemaId` string - PlateCreationTableNotePart - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `type` 'plate_creation_table': The type of the note. Type determines what other fields are present. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnProvenanceUUID` string - `isReadOnly` boolean - `name` string - `name` string - `plateSchemaId` string - BoxCreationTableNotePart - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `type` 'box_creation_table': The type of the note. Type determines what other fields are present. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnProvenanceUUID` string - `isReadOnly` boolean - `name` string - `name` string - `boxSchemaId` string - MixturePrepTableNotePart - `indentation` integer: All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example. - `type` 'mixture_prep_table': The type of the note. Type determines what other fields are present. - `apiId` string - `columns` StructuredTableColumnInfo[] - `columnProvenanceUUID` string - `isReadOnly` boolean - `name` string - `name` string - `mixtureSchemaId` string - `title` string, nullable: Optional title of a section if sections are enabled. - `fields` Fields - `id` string: ID of the entry template - `modifiedAt` string: DateTime the template was last modified - `name` string: Title of the template - `schema` EntrySchema: Entry schema - `id` string: ID of the entry schema - `modifiedAt` string, date-time: DateTime the Entry Schema was last modified - `name` string: Name of the entry schema - `templateCollectionId` string: ID of the collection that contains the template - `webURL` string: URL of the template --- [API](https://skmtc.dev/benchling/apis/benchling-api-beta.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-beta/revisions/eba0b3d5b98e?raw)