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

# Retrieve a team glossary item

GET https://acme-api.invivo.benchling.com/api/public/v1/team-glossary/{teamGlossaryId}

Retrieves the details of an existing team glossary entry.

Reference: https://docs.benchling.com/in-vivo/team-glossary/get

## Authentication

- OAuth2 — send the obtained token as `Authorization: Bearer <token>`

## Request

### Path parameters

- `teamGlossaryId` (string, required) — The unique identifier of the team glossary.

## Response

### 200

The requested team glossary entry.

- `id` (string, required) — Unique identifier for an entry in your team's own glossary.
- `title` (string, required) — The title of the team glossary entry.
- `label` (string, required, nullable) — A short label for the team glossary entry.
- `group` (enum, required) — The group a glossary entry belongs to. Shared glossary entries used by the public API are typically euthanize reasons; team glossary entries may also be sample or observation types.
  - Allowed values: `samples`, `observations`, `euthanize_reasons`
- `description` (string, required, nullable) — A longer description of the team glossary entry.
- `type` (enum, required) — How values are recorded against a team glossary entry. `numeric` entries have a configured min/max range, `severity` entries accept Mild/Moderate/Severe, and `none` entries carry free-form text with no structured value.
  - Allowed values: `none`, `severity`, `numeric`
- `status` (enum, required) — Whether a team glossary entry is available for use or archived.
  - Allowed values: `active`, `archived`
- `options` (TeamGlossaryOptionsV1, required, nullable) — Type-specific configuration for this glossary entry. Null when the entry has no numeric bounds or sample-collection details.

## Errors

### 400 Bad Request Error

The request was rejected. Validation failures return a `ValidationErrorResponse`; an unrecognised `X-Studies-Api-Version` header returns an `AuthErrorResponse` with the code `invalid_header`.

- `BadRequestErrorResponse`

### 401 Unauthorized Error

Authentication failed. The body is normally empty; when an otherwise valid access token is missing required claims the body is an `AuthErrorResponse` with the code `invalid_token`.

- `any`

### 403 Forbidden Error

The access token does not grant the scopes this operation requires. The body is normally empty; when the token's team is missing or deleted the body is an `AuthErrorResponse` with the code `invalid_data`.

- `any`

### 404 Not Found Error

No resource matching the given identifier exists on your team. The body is empty.

- `any`

### 429 Too Many Requests Error

A rate limit was exceeded. Retry once the window resets; no `Retry-After` header is sent, so use `X-RateLimit-Reset`.

- `error` ("rate_limit_exceeded", required) — A machine-readable error code.
- `message` (string, required) — A human-readable explanation of the failure.

## Types

### TeamGlossaryOptionsV1

Configuration attached to a team glossary entry. Numeric observation entries carry `min`/`max`; sample entries may carry `details`. Properties that do not apply are omitted rather than sent as null.

- `min` (string, optional) — The minimum accepted numeric value, as a string.
- `max` (string, optional) — The maximum accepted numeric value, as a string.
- `details` (list of enum, optional) — A list of sample glossary collection detail types.
  - Allowed values: `weight`, `volume`, `width`, `length`, `depth`

### ValidationErrorResponse

Returned when a request body or parameter fails validation.

- `message` (string, required) — A summary of the failure.
- `errors` (map from string to list of string, required) — Failure messages keyed by the offending field, using the field's name as it appears on the wire. Nested fields are dotted, e.g. `schedule.duration`.

### AuthErrorResponse

Returned when a request is rejected during authentication, before it is processed.

- `error` (enum, required) — A machine-readable error code.
  - Allowed values: `invalid_header`, `invalid_token`, `invalid_data`
- `error_description` (string, required) — A human-readable explanation of the failure.

### ProblemDetail

An RFC 9457 problem detail, returned when a request is rejected before it reaches a controller method — most commonly an unparseable or absent JSON body. Unlike the rest of this API, null members are omitted rather than serialised as `null`.

- `title` (string, required) — A short, human-readable summary of the problem type.
- `status` (integer, required) — The HTTP status code, repeated in the body.
- `detail` (string, required) — A human-readable explanation specific to this occurrence.
- `instance` (string, required) — The path of the request that produced the problem.

## Examples

**Response**

```json
{
  "id": "tgy_6vQ3mKpNvR7zTw8YbCdFgW",
  "title": "string",
  "label": "string",
  "group": "euthanize_reasons",
  "description": "string",
  "type": "numeric",
  "status": "active",
  "options": {
    "min": "string",
    "max": "string",
    "details": [
      "weight"
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://acme-api.invivo.benchling.com/api/public/v1/team-glossary/tgy_6vQ3mKpNvR7zTw8YbCdFgW"

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

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

print(response.json())
```

```javascript
const url = 'https://acme-api.invivo.benchling.com/api/public/v1/team-glossary/tgy_6vQ3mKpNvR7zTw8YbCdFgW';
const options = {method: 'GET', headers: {Authorization: '<token>.'}};

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