---
title: "getHoneytoken"
description: "Get a honeytoken"
canonical: "https://pgbeam.com/docs/ts-sdk/honeytokens/getHoneytoken"
last-updated: "2026-09-09T11:37:53.000Z"
---

# getHoneytoken

> Get a honeytoken

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

Returns a single honeytoken by ID.

## Usage

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

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