Skip to main content
Retrieve detailed information about a specific short link.

​
Endpoint

GET /api/links/{linkId}

​
Headers

​
Authorization
string
required
Bearer token for authentication

​
Path Parameters

​
linkId
string
required
Link UUID

​
Response

​
id
string
Link UUID
​
name
string
Link name
​
url
string
Destination URL
​
slug
string
URL slug
​
userId
string
Owner user UUID (null for team links)
​
teamId
string
Team UUID (null for personal links)
​
createdAt
string
ISO 8601 timestamp of creation
​
updatedAt
string
ISO 8601 timestamp of last update

​
Example Request

curl "https://your-umami-instance.com/api/links/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Product Launch",
  "url": "https://example.com/product-launch",
  "slug": "launch2024",
  "userId": "660e8400-e29b-41d4-a716-446655440001",
  "teamId": null,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-02-20T14:15:00.000Z"
}

​
Error Responses

​
401
error
Unauthorized - You don’t have permission to view this link
​
404
error
Not Found - Link does not exist
You must have view permissions for the link. This includes being the owner or a team member for team links.

Build docs developers (and LLMs) love

Get started for freeTalk to us