Docs
API

Get project

GEThttps://api.visitors.now/v1/project

Returns the project associated with the API key used for authentication.

Request

index.ts
const res = await fetch("https://api.visitors.now/v1/project", {
  headers: { Authorization: `Bearer ${VISITORS_API_KEY}` },
});

const project = await res.json();

Response

{
  "id": "fe14d7a2-0f3f-4dc4-9c0b-6f4a49f5c751",
  "name": "Visitors",
  "domain": "visitors.now",
  "token": "b1a57b77-01f4-42e4-b7b4-1709b4d21d34",
  "public": false,
  "currency": "USD",
  "hostnames": ["visitors.now", "*.visitors.now"],
  "blockedIps": ["203.0.113.10", "198.51.100.0/24"],
  "blockedPathnames": ["/admin/*"],
  "maskedPathnames": ["/users/:id"],
  "createdAt": "2025-11-28T14:30:56.834Z",
  "updatedAt": "2026-02-11T04:51:52.559Z"
}

Response fields

id

string

Unique project identifier.

name

string

Display name of the project.

domain

string

The domain associated with the project.

token

string

Tracking script token for the project.

public

boolean

Whether the project dashboard is publicly accessible.

currency

string

Currency used for revenue display.

hostnames

string[]

Hostnames allowed to send tracking events for this project.

blockedIps

string[]

IP addresses or IPv4 CIDR ranges blocked from sending tracking events.

blockedPathnames

string[]

Pathnames blocked from being tracked. Wildcards are supported.

maskedPathnames

string[]

Pathname patterns aggregated in analytics output.

createdAt

string

ISO 8601 timestamp of when the project was created.

updatedAt

string

ISO 8601 timestamp of the last update.