---
title: "getHoneytoken"
description: "Get a honeytoken"
canonical: "https://pgbeam.com/docs/ts-sdk/honeytokens/getHoneytoken"
last-updated: "2026-10-24T21:15:09.000Z"
---

# getHoneytoken

> Get a honeytoken

URL: https://pgbeam.com/docs/ts-sdk/honeytokens/getHoneytoken

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Returns a single honeytoken by ID.

## Usage

```typescript
const result = await api.honeytokens.getHoneytoken({
  pathParams: { project_id: "prj_xxx", honeytoken_id: "hnt_xxx" },
});
```

## Parameters

| Parameter                | Type     | Required | Description                                            |
| ------------------------ | -------- | -------- | ------------------------------------------------------ |
| pathParams.project_id    | `string` | Yes      | Unique project identifier (prefixed, e.g. prj_xxx).    |
| pathParams.honeytoken_id | `string` | Yes      | Unique honeytoken identifier (prefixed, e.g. hnt_xxx). |

## Response

`Promise<Honeytoken>`: the honeytoken.

## Example

```typescript
import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbu_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.honeytokens.getHoneytoken({
  pathParams: { project_id: "prj_xxx", honeytoken_id: "hnt_xxx" },
});
```

## Errors

| Status | Description                                                                                                                                                                                                                                                                                           |
| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.                                                                                                                                                                   |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                                                                                                                                                                                          |
| 403    | The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status. |
| 404    | The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.                                                                                                                                                                                               |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                                                                                                                                                                                        |