API

Create invite

POSThttps://api.visitors.now/v1/invites

Sends an invite to join the project.

Request

index.ts
const res = await fetch("https://api.visitors.now/v1/invites", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${VISITORS_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "jane@example.com",
  }),
});

const invite = await res.json();

Body parameters

email

stringrequired

The email address to invite.

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "email": "jane@example.com",
  "projectId": "fe14d7a2-0f3f-4dc4-9c0b-6f4a49f5c751",
  "acceptedAt": null,
  "createdAt": "2026-03-07T12:00:00.000Z"
}