This website requires JavaScript to run properly.
to.it.com
Reclama tu @nombre
Referencia de la API

Especificación OpenAPI.

Mini pages, link-in-bio profiles, and URL shortener API. Use the Public endpoints to check handle availability and access public profile data. to.it.com is a simple, affordable link-in-bio, mini landing page, bento-style profile, and URL shortener platform.

Inicio rápidoLeer documentación

Versión 1.0.0

api.to.it.com
Autenticación Bearer

Funciones de la API

Crear enlaces cortos
Consultar analíticas de clics
Gestionar claves de API
Con límites de uso y segura

Enlaces cortos

Analíticas

Claves de API

OpenAPI

01

Descripción general

Mini pages, link-in-bio profiles, and URL shortener API.

Use the Public endpoints to check handle availability and access public profile data.
to.it.com is a simple, affordable link-in-bio, mini landing page, bento-style profile, and URL shortener platform.

v1.0.0

URL base:

  • https://api.to.it.comPublic API base URL

02

Autenticación

apiKeyApiKeyAuth

API key authentication using Bearer token format: Bearer toit_your_api_key_here

Cabecera:Authorization

03

Endpoints

gethttps://api.to.it.com/handle-availability
Public

Check if a handle is available

Checks whether a given handle (username) is available for registration. No authentication required. Returns availability status, the normalized handle, and a reason if the handle is unavailable.

Parámetros

NombreDescripción
username
stringqueryObligatorio
The handle to check (e.g., "john doe")

Respuestas

patchhttps://api.to.it.com/v1/short-links/{shortLinkId}
Short Links

Update a short link

Updates an existing short link in the authenticated workspace.

Parámetros

NombreDescripción
shortLinkId
stringpathObligatorio

Cuerpo de la solicitud

application/jsonobligatorio
{
  "type": "object",
  "properties": {
    "targetUrl": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "DISABLED"
      ]
    },
    "startsAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Schedule activation (Plus/Business)"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Schedule expiration (Plus/Business)"
    },
    "countdownPage": {
      "type": "boolean",
      "description": "Show a live countdown page to visitors before startsAt (requires scheduling + startsAt)"
    },
    "captchaEnabled": {
      "type": "boolean",
      "description": "Require Cloudflare Turnstile CAPTCHA before redirect (all plans)"
    },
    "password": {
      "type": "string",
      "description": "Set or replace the visitor password (Plus/Business)"
    },
    "clearPassword": {
      "type": "boolean",
      "description": "Remove password protection from the link"
    },
    "passwordBeforeCountdown": {
      "type": "boolean",
      "description": "When both password and countdown are enabled, show password before countdown"
    }
  }
}

Respuestas

gethttps://api.to.it.com/v1/short-links/{shortLinkId}
Short Links

Get a short link

Parámetros

NombreDescripción
shortLinkId
stringpathObligatorio

Respuestas

gethttps://api.to.it.com/v1/short-links
Short Links

List short links

Returns short links for the authenticated workspace.

Parámetros

NombreDescripción
profileId
stringquery

Respuestas

posthttps://api.to.it.com/v1/short-links
Short Links

Create a short link

Creates a new short link in the authenticated workspace.

Cuerpo de la solicitud

application/jsonobligatorio
{
  "type": "object",
  "required": [
    "targetUrl"
  ],
  "properties": {
    "targetUrl": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "profileId": {
      "type": "string",
      "format": "uuid"
    },
    "isProfileScoped": {
      "type": "boolean"
    },
    "startsAt": {
      "type": "string",
      "format": "date-time",
      "description": "Schedule activation (Plus/Business)"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Schedule expiration (Plus/Business)"
    },
    "countdownPage": {
      "type": "boolean",
      "description": "Show a live countdown page to visitors before startsAt (requires scheduling + startsAt)"
    },
    "captchaEnabled": {
      "type": "boolean",
      "description": "Require Cloudflare Turnstile CAPTCHA before redirect (all plans)"
    },
    "password": {
      "type": "string",
      "description": "Plain-text password for visitors (Plus/Business); stored as bcrypt hash"
    },
    "passwordBeforeCountdown": {
      "type": "boolean",
      "description": "When both password and countdown are enabled, show password first by default"
    },
    "utmSource": {
      "type": "string"
    },
    "utmMedium": {
      "type": "string"
    },
    "utmCampaign": {
      "type": "string"
    },
    "utmTerm": {
      "type": "string"
    },
    "utmContent": {
      "type": "string"
    }
  }
}

Respuestas

gethttps://api.to.it.com/v1/short-links/{shortLinkId}/analytics
Analytics

Get short link analytics

Returns click analytics for a short link within the plan retention window.

Parámetros

NombreDescripción
shortLinkId
stringpathObligatorio
includeBots
booleanquery

Respuestas

04

Esquemas

Error

Integración

Empieza a crear con la API.

Crea una clave de API, sigue la guía de inicio rápido y automatiza los enlaces cortos desde tu stack.

Inicio rápidoGestionar claves