--- title: "List entry templates" method: GET path: "/entry-templates" tags: ["entries"] --- # List entry templates `GET /entry-templates` ## Request - Base URL: `https://{tenant_name}.benchling.com/api/v2` - URL: `https://{tenant_name}.benchling.com/api/v2/entry-templates` - Auth: HTTP bearer List entry templates ## Query parameters - `pageSize` integer - `nextToken` string - `modifiedAt` string - `name` string - `templateCollectionId` string - `ids` string - `schemaId` string - `returning` string ## Response `200` Returns a list of entry templates. Entry templates are templates that users can base new notebook entries off of. - EntryTemplatesPaginatedList - `entryTemplates` EntryTemplate[] - `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` EntryNotePart[] - union: Notes are the main building blocks of entries. Each note corresponds roughly to a paragraph. - object: app_canvas variant - `type` 'app_canvas', required: The type of the note. Type determines what other fields are present. - `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. - `appId` string: The API identifier for the Benchling App. - `canvasId` string: The API identifier for this Analysis Chart. - `featureId` string: The developer ID assigned to the feature of this App Canvas. - object: assay_run variant - `type` 'assay_run', required: The type of the note. Type determines what other fields are present. - `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. - `assayRunId` string, nullable - `assayRunSchemaId` string - object: box_creation_table variant - `type` 'box_creation_table', required: The type of the note. Type determines what other fields are present. - `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. - `apiId` string - `columns` StructuredTableColumnInfo[] - … - `name` string - `boxSchemaId` string - object: 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 - `type` 'text' | 'code' | 'list_bullet' | 'list_number', required: The type of the note. Type determines what other fields are present. - `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. - `links` EntryLink[]: Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - … - `text` string: The textual contents of the note. - object: An attached user-uploaded file - `type` 'external_file', required: The type of the note. Type determines what other fields are present. - `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. - `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. - … - `text` string: The caption of the file attachment. - object: inventory_container_table variant - `type` 'inventory_container_table', required: The type of the note. Type determines what other fields are present. - `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. - `apiId` string - `columns` StructuredTableColumnInfo[] - … - `name` string - `destinationContainerSchemaId` string - `mode` 'create_and_fill' | 'fill' | 'update' - object: inventory_plate_table variant - `type` 'inventory_plate_table', required: The type of the note. Type determines what other fields are present. - `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. - `apiId` string - `columns` StructuredTableColumnInfo[] - … - `name` string - `destinationPlateSchemaId` string, nullable - `destinationWellSchemaId` string - `mode` 'create_and_fill' | 'fill' | 'update' - object: 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 - `type` 'text' | 'code' | 'list_bullet' | 'list_number', required: The type of the note. Type determines what other fields are present. - `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. - `links` EntryLink[]: Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - … - `text` string: The textual contents of the note. - object: One "line" of a checklist - `type` 'list_checkbox', required: The type of the note. Type determines what other fields are present. - `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. - `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. - … - `text` string: The textual contents of the note. - object: 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 - `type` 'text' | 'code' | 'list_bullet' | 'list_number', required: The type of the note. Type determines what other fields are present. - `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. - `links` EntryLink[]: Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - … - `text` string: The textual contents of the note. - object: lookup_table variant - `type` 'lookup_table', required - `apiId` string - `columns` StructuredTableColumnInfo[] - … - `name` string - object: mixture_prep_table variant - `type` 'mixture_prep_table', required: The type of the note. Type determines what other fields are present. - `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. - `apiId` string - `columns` StructuredTableColumnInfo[] - … - `name` string - `mixtureSchemaId` string - object: note_linked_chart variant - `type` 'note_linked_chart', required: The type of the note. Type determines what other fields are present. - `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. - `chart` ChartNotePartChart: The full configuration for the chart to be displayed in-line in this note part. - … - object: plate_creation_table variant - `type` 'plate_creation_table', required: The type of the note. Type determines what other fields are present. - `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. - `apiId` string - `columns` StructuredTableColumnInfo[] - … - `name` string - `plateSchemaId` string - object: registration_table variant - `type` 'registration_table', required: The type of the note. Type determines what other fields are present. - `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. - `apiId` string - `columns` StructuredTableColumnInfo[] - … - `name` string - `entitySchemaId` string - object: results_table variant - `type` 'results_table', required: The type of the note. Type determines what other fields are present. - `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. - `apiId` string - `columns` StructuredTableColumnInfo[] - … - `name` string - `assayResultSchemaId` string - object: A table with rows and columns of text - `type` 'table', required: The type of the note. Type determines what other fields are present. - `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. - `links` EntryLink[]: Array of links referenced in the caption via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - … - `table` EntryTable: Actual tabular data with rows and columns of text on the note. - … - `text` string: The caption of the table. - object: 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 - `type` 'text' | 'code' | 'list_bullet' | 'list_number', required: The type of the note. Type determines what other fields are present. - `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. - `links` EntryLink[]: Array of links referenced in text via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - … - `text` string: The textual contents of the note. - object: text_box variant - `type` 'text_box', required: The type of the note. Type determines what other fields are present. - `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. - `links` EntryLink[]: Array of links referenced via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note. - … - `name` string - `text` 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 - `nextToken` string ## Other responses - `400`: Bad Request --- [API](https://skmtc.dev/benchling/apis/benchling-api-2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-2/revisions/01d2fa8523cd?raw)