---
title: "GET /Links/ByCode/{LinkCode}"
method: GET
path: "/Links/ByCode/{LinkCode}"
tags: ["Links"]
---

# GET /Links/ByCode/{LinkCode}

`GET /Links/ByCode/{LinkCode}`

## Request

- Base URL: `https://api.pishock.com`
- URL: `https://api.pishock.com/Links/ByCode/{LinkCode}`
- Auth: one of:
  - API key in header `X-PiShock-Token`
  - API key in header `X-PiShock-UserId`
  - API key in header `X-PiShock-Server-Key`
  - API key in header `X-PiShock-Api-Key`

## Path parameters

- `LinkCode` string, required

## Response `200`

Returns the details of a specific link.

- GetLinkResponse: Response model for retrieving a specific link.
  - `LinkId` integer
  - `Name` string
  - `Paused` boolean
  - `UserId` integer, nullable
  - `OwnerId` integer
  - `RemainingActivations` integer
  - `ShowCountdown` boolean
  - `ShowUsages` boolean
  - `ShockEnabled` boolean
  - `VibrateEnabled` boolean
  - `BeepEnabled` boolean
  - `MaxIntensity` integer
  - `MaxDuration` integer
  - `ForceWarning` boolean
  - `ForceLogin` boolean
  - `ActivateOnLoad` boolean
  - `Expiry` string, date-time, nullable

## Other responses

- `401`: Unauthorized
- `403`: Link is claimed by another user.

## Changes

- **2026-09-22** `e39f4566848b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pishock/apis/pishock-public-api-v1/changes/Links/ByCode/:LinkCode/get.md)

---

[API](https://skmtc.dev/pishock/apis/pishock-public-api-v1.md) - [All operations](https://skmtc.dev/pishock/apis/pishock-public-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/pishock/apis/pishock-public-api-v1/revisions/6398a6a65c40?raw)