Skip to main content

​
Get Website

Retrieve detailed information about a specific website.

​
Endpoint

GET /api/websites/{websiteId}

​
Headers

​
Authorization
string
required
Bearer token for authentication

​
Path Parameters

​
websiteId
string
required
Website UUID

​
Response

​
id
string
Website UUID
​
name
string
Website name
​
domain
string
Website domain
​
shareId
string
Public share ID for analytics sharing
​
userId
string
Owner user UUID (null for team websites)
​
teamId
string
Team UUID (null for personal websites)
​
createdBy
string
UUID of user who created the website
​
createdAt
string
ISO 8601 timestamp of creation
​
updatedAt
string
ISO 8601 timestamp of last update

​
Example Request

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

​
Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Website",
  "domain": "example.com",
  "shareId": "abc123def456",
  "userId": "660e8400-e29b-41d4-a716-446655440001",
  "teamId": null,
  "createdBy": "660e8400-e29b-41d4-a716-446655440001",
  "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 website
​
404
error
Not Found - Website does not exist
You must have view permissions for the website. This includes being the owner, a team member (for team websites), or having admin privileges.

Build docs developers (and LLMs) love

Get started for freeTalk to us