> This page is for Developer Documentation.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.benchling.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.benchling.com/_mcp/server.

# List PublishingRecord items

GET https://{tenant_name}.benchling.com/api/v3/publishing-record/items

List PublishingRecord items.

Reference: https://docs.benchling.com/docs/api/benchling-api/publishing-record/list

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `createdAt.gt` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30.
- `createdAt.gte` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or after the specified time. e.g. >= 2017-04-30.
- `createdAt.lt` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. \< 2017-04-30.
- `createdAt.lte` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or before the specified time. e.g. \<= 2017-04-30.
- `id.anyOf` (list of string, optional) — Restricts results to those matching any of the specified IDs. Comma-separated list.
- `modifiedAt.gt` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified after the specified time. e.g. > 2017-04-30.
- `modifiedAt.gte` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or after the specified time. e.g. >= 2017-04-30.
- `modifiedAt.lt` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified before the specified time. e.g. \< 2017-04-30.
- `modifiedAt.lte` (string, optional) — Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or before the specified time. e.g. \<= 2017-04-30.
- `nextToken` (string, optional) — Token for pagination
- `omit` (list of string, optional) — Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.
- `pageSize` (integer, optional) — Number of results to return. Defaults to 50, maximum of 100.
- `publishableId.anyOf` (list of string, optional) — Restricts results to records of any of the specified publishable IDs (e.g. template or procedure IDs). Comma-separated list.
- `returning` (list of string, optional) — Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.
- `sort` (enum, optional, default: modifiedAt:desc) — Method by which to order results. Valid sorts are: createdAt (created time, oldest first) and modifiedAt (modified time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is modifiedAt:desc.
  - Allowed values: `createdAt:asc`, `createdAt:desc`, `modifiedAt:asc`, `modifiedAt:desc`

### Headers

- `EARLY-ACCESS` (string, optional) — Set to true to access beta operations via /api/v3.

## Response

### 200

OK

- `items` (list of PublishingRecord, optional)
- `nextToken` (string, optional, nullable)

## Errors

### 400 Bad Request Error

Bad Request

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 403 Forbidden Error

Forbidden

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 404 Not Found Error

Not Found

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 429 Too Many Requests Error

Too Many Requests

- `detail` (TooManyRequestsErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 500 Internal Server Error

Internal Server Error

- `detail` (InternalServerErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `errorId` (string, optional)

## Types

### PublishingRecord

A single publish of a versioned item such as a Template, Subtemplate, or Procedure (see `Publishable`). Each record captures which version was published, who published it, when, and its current `publishingStatus`. Records are ordered by `index`, starting at 0 for the first publish. Records change only through publishing actions: publishing a new version marks the previous EFFECTIVE record SUPERSEDED, and withdrawing marks the EFFECTIVE record WITHDRAWN. Both transitions set `unpublishedAt` and `unpublishedBy`. Use a publishable's `currentPublishingRecord` for its latest record. Records created when publishing was first enabled on a tenant are backfilled from existing versions: `publishedBy` is the version's creator, and `versionName` is `(SYSGEN) Version N`.

- `__typename` (string, optional)
- `createdAt` (string, optional)
- `id` (string, optional)
- `index` (integer, optional) — Position of this record in the publishable's publishing history, starting at 0.
- `modifiedAt` (string, optional)
- `publishableId` (string, optional) — ID of the published item, such as a Template, Subtemplate, or Procedure.
- `publishableVersionId` (string, optional) — ID of the version that was published. For Templates and Subtemplates, this matches `versionMetadata.versionId`.
- `publishedAt` (string, optional) — When the version was published.
- `publishedBy` (PrincipalRef, optional) — User or app that published the version.
- `publishingStatus` (enum, optional) — Lifecycle state of this published version.
  - Allowed values: `EFFECTIVE`, `SUPERSEDED`, `WITHDRAWN`
- `unpublishedAt` (string, optional, nullable) — When this record was superseded or withdrawn. Null while the record is effective.
- `unpublishedBy` (PrincipalRef, optional, nullable) — User or app that published the replacement version or withdrew this version. Null while the record is effective.
- `versionDescription` (string, optional, nullable) — Optional description given to the version when it was published.
- `versionName` (string, optional) — Name given to the version when it was published.

### GeneralErrorDetail

- string
- map from string to any

### TooManyRequestsErrorDetail

- string
- map from string to any

### InternalServerErrorDetail

- string
- map from string to any

### PrincipalRef

- `__typename` (string, optional)
- `id` (string, optional)

## Examples

**Response**

```json
{
  "items": [
    {
      "__typename": "string",
      "createdAt": "string",
      "id": "string",
      "index": 1,
      "modifiedAt": "string",
      "publishableId": "string",
      "publishableVersionId": "string",
      "publishedAt": "string",
      "publishedBy": {
        "__typename": "string",
        "id": "string"
      },
      "publishingStatus": "EFFECTIVE",
      "unpublishedAt": null,
      "unpublishedBy": {
        "__typename": "string",
        "id": "string"
      },
      "versionDescription": null,
      "versionName": "string"
    }
  ],
  "nextToken": "string"
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/publishing-record/items"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{tenant_name}.benchling.com/api/v3/publishing-record/items';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```