01
Visão geral
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.
URLs base:
https://api.to.it.comPublic API base URL
02
Autenticação
API key authentication using Bearer token format: Bearer toit_your_api_key_here
Authorization03
Endpoints
https://api.to.it.com/handle-availabilityCheck 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
| Nome | Descrição |
|---|---|
usernamestringqueryObrigatório | The handle to check (e.g., "john doe") |
Respostas
https://api.to.it.com/v1/short-links/{shortLinkId}Update a short link
Updates an existing short link in the authenticated workspace.
Parâmetros
| Nome | Descrição |
|---|---|
shortLinkIdstringpathObrigatório |
Corpo da solicitação
{
"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)"
},
"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"
}
}
}Respostas
https://api.to.it.com/v1/short-links/{shortLinkId}Get a short link
Parâmetros
| Nome | Descrição |
|---|---|
shortLinkIdstringpathObrigatório |
Respostas
https://api.to.it.com/v1/short-linksList short links
Returns short links for the authenticated workspace.
Parâmetros
| Nome | Descrição |
|---|---|
profileIdstringquery |
Respostas
https://api.to.it.com/v1/short-linksCreate a short link
Creates a new short link in the authenticated workspace.
Corpo da solicitação
{
"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)"
},
"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"
}
}
}Respostas
https://api.to.it.com/v1/short-links/{shortLinkId}/analyticsGet short link analytics
Returns click analytics for a short link within the plan retention window.
Parâmetros
| Nome | Descrição |
|---|---|
shortLinkIdstringpathObrigatório |
Respostas
04