> 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.

# Get PublishingRecord by ID

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

Get a single PublishingRecord by ID.

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

## Authentication

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

## Request

### Path parameters

- `publishing_record_id` (string, required) — ID of the PublishingRecord.

### Query parameters

- `returning` (list of string, optional) — Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.
- `omit` (list of string, optional) — Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

### Headers

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

## Response

### 200

OK

- `__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.

## 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

### PrincipalRef

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

### GeneralErrorDetail

- string
- map from string to any

### TooManyRequestsErrorDetail

- string
- map from string to any

### InternalServerErrorDetail

- string
- map from string to any

## Examples

**Response**

```json
{
  "__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"
}
```

**SDK Code**

```python
import requests

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

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/publishing_record_id';
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);
}
```