Get notebook entries using entry IDs or display IDs

GET

https://{tenant_name}.benchling.com/api/v2/entries:bulk-get

GET

/api/v2/entries:bulk-get

curl https://{tenant_name}.benchling.com/api/v2/entries:bulk-get \
     -H "Authorization: Bearer <token>"

{
  "entries": [
    {
      "apiURL": "https://benchling.com/api/v2/entries/etr_tv7m7B78",
      "archiveRecord": {
        "reason": "Made in error"
      },
      "assignedReviewers": [
        {
          "handle": "string",
          "id": "string",
          "name": "string"
        }
      ],
      "authors": [
        {
          "handle": "string",
          "id": "string",
          "name": "string"
        }
      ],
      "createdAt": "2024-01-15T09:30:00Z",
      "creator": {
        "handle": "string",
        "id": "string",
        "name": "string"
      },
      "customFields": {
        "Legacy ID": {
          "value": "STR100"
        }
      },
      "days": [
        {
          "date": "string",
          "notes": [
            {
              "type": "text",
              "indentation": 0,
              "links": [
                {
                  "id": "string",
                  "type": "link",
                  "webURL": "string"
                }
              ],
              "text": "string"
            }
          ],
          "title": "string"
        }
      ],
      "displayId": "string",
      "entryTemplateId": "string",
      "fields": {},
      "folderId": "string",
      "id": "string",
      "modifiedAt": "string",
      "name": "string",
      "reviewRecord": {
        "comment": "string",
        "reviewChanges": [
          {
            "action": "SEND_FOR_REVIEW",
            "comment": "string",
            "createdAt": "2024-01-15T09:30:00Z",
            "esigned": true,
            "id": "string",
            "reviewSnapshot": {
              "createdAt": "2024-01-15T09:30:00Z",
              "downloadURL": "string",
              "expiresAt": "2024-01-15T09:30:00Z",
              "size": 1,
              "status": "PENDING"
            }
          }
        ],
        "reviewProcesses": [
          {
            "completionStatus": "APPROVED",
            "id": "string",
            "name": "string",
            "stages": [
              {
                "actionLabel": "APPROVE",
                "id": "string",
                "name": "string",
                "reviewers": [
                  {
                    "handle": "string",
                    "id": "string",
                    "name": "string",
                    "status": "BLOCKED"
                  }
                ]
              }
            ],
            "type": "SELF_REVIEW"
          }
        ],
        "status": "ACCEPTED"
      },
      "schema": {
        "id": "string",
        "modifiedAt": "2017-04-18T05:55:48.685345+00:00",
        "name": "string"
      },
      "webURL": "string"
    }
  ]
}

Get notebook entries using entry IDs or display IDs

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entryIdsstringOptional

Comma-separated list of Entry IDs.

displayIdsstringOptional

Comma-separated list of Entry Display IDs.

returningstringOptional

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, ’*’. For more information, click here.

Note: “entries.days.notes” cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g., “entries.days.notes.text” will return the same model as “entries.days.notes”.

Response

Returns a list of entries. Entries are notes that users can take. They’re organized by “days” (which are user-configurable) and modeled within each day as a list of “notes.” Each note has a type - the simplest is a “text” type, but lists, tables, and external files are also supported.

Note: the current Entry resource has a few limitations:

Formatting information is not yet supported. Header formatting, bolding, and other stylistic information is not presented.
Data in tables is presented as text always - numeric values will need to be parsed into floats or integers, as appropriate.

Note: Data in Results tables are not accessible through this API call. Results table data can be called through the Results API calls.

entrieslist of objectsOptional

Errors

400

Bad Request Error