Splash pages API
Make, list, change and delete splash pages, then show one for a few seconds before a short link opens, with the siz.la REST API.
A splash page is a page shown for a few seconds before a link opens. It has a title, some text, an optional picture and a button, and a countdown that moves on by itself. Visitors can press the button to go at once or stop the timer to stay. Search engines and link previews skip it and get the link's usual answer.
Make the page with the calls below, or in the members area under Splash pages, where you can also add a picture. Then use it on a link with the splash option (see (https://siz.la/docs/links)). A link shows a splash page or a call to action, not both. How many splash pages you can keep depends on your plan.
Pixels set on the link fire on the splash page. Reading needs a key; making, changing and deleting need a key with write access, like the link calls.
List splash pages
GET/api/splash
Your splash pages by name, with how many links use each.
Needs: API key.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | Query | integer | How many splash pages to return on a page. 1 to 100. Default 15. |
page | Query | integer | Which page to return. At least 1. Default 1. |
Example request
curl "https://siz.la/api/splash?limit=10&page=1" \
-H "Authorization: Bearer $SIZLA_API_KEY"const response = await fetch("https://siz.la/api/splash?limit=10&page=1", {
headers: {
Authorization: `Bearer ${process.env.SIZLA_API_KEY}`,
},
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.get(
"https://siz.la/api/splash",
headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
params={
"limit": 10,
"page": 1,
},
)
print(response.json())$ch = curl_init('https://siz.la/api/splash?limit=10&page=1');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer '.getenv('SIZLA_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);Example answer, status 200
{
"error": "0",
"data": {
"result": 1,
"perpage": 10,
"currentpage": 1,
"nextpage": null,
"maxpage": 1,
"splash": [
{
"id": 7,
"name": "Menu launch",
"date": "2026-11-12 10:00:00",
"title": "Taking you to the new menu",
"message": "Show this page at the counter for a free coffee.",
"button_label": "Continue",
"seconds": 5,
"background_color": "#ffffff",
"text_color": "#17171a",
"button_color": "#e2500f",
"show_branding": true,
"links": 3
}
]
}
}Notes
erroris the text"0"on this endpoint and the number0on the others.
Make a splash page
POST/api/splash/add
Make a splash page. Use it on a link with the splash option. A picture can be added in the members area.
Needs: API key with write access.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
name (required) | Body | string | The splash page's name, for you. Visitors do not see it. Up to 80 characters. |
title (required) | Body | string | The heading visitors see. Up to 120 characters. |
message | Body | string | A few lines under the title. Send an empty string to remove it. Up to 500 characters. |
button_label | Body | string | The words on the button, which skips the wait. The default is Continue. Up to 40 characters. |
seconds | Body | integer | How long the page waits before it moves on by itself. 2 to 15. Default 5. |
background_color | Body | string | Page color as six-digit hex, such as #ffffff. |
text_color | Body | string | Text color as six-digit hex. |
button_color | Body | string | Button color as six-digit hex. |
show_branding | Body | boolean | Whether the siz.la mark is shown. It can only be turned off on the plans that remove it. Needs Pro and the plans above it. |
Example request
curl -X POST "https://siz.la/api/splash/add" \
-H "Authorization: Bearer $SIZLA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Menu launch","title":"Taking you to the new menu","message":"Show this page at the counter for a free coffee.","seconds":5}'const response = await fetch("https://siz.la/api/splash/add", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SIZLA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Menu launch",
"title": "Taking you to the new menu",
"message": "Show this page at the counter for a free coffee.",
"seconds": 5
}),
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.post(
"https://siz.la/api/splash/add",
headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
json={
"name": "Menu launch",
"title": "Taking you to the new menu",
"message": "Show this page at the counter for a free coffee.",
"seconds": 5,
},
)
print(response.json())$ch = curl_init('https://siz.la/api/splash/add');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer '.getenv('SIZLA_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Menu launch',
'title' => 'Taking you to the new menu',
'message' => 'Show this page at the counter for a free coffee.',
'seconds' => 5,
]),
]);
$data = json_decode(curl_exec($ch), true);Example answer, status 200
{
"error": 0,
"id": 7,
"name": "Menu launch"
}Errors specific to this call
400: The name or title is missing, a value is not allowed, or the account has the most splash pages its plan allows.
Update a splash page
PUT/api/splash/{id}/update
Change a splash page. Only the fields you send change, and every link that uses it shows the new page.
Needs: API key with write access.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id (required) | Path | integer | The splash page's id. At least 1. |
name | Body | string | The splash page's name, for you. Visitors do not see it. Up to 80 characters. |
title | Body | string | The heading visitors see. Up to 120 characters. |
message | Body | string | A few lines under the title. Send an empty string to remove it. Up to 500 characters. |
button_label | Body | string | The words on the button, which skips the wait. The default is Continue. Up to 40 characters. |
seconds | Body | integer | How long the page waits before it moves on by itself. 2 to 15. Default 5. |
background_color | Body | string | Page color as six-digit hex, such as #ffffff. |
text_color | Body | string | Text color as six-digit hex. |
button_color | Body | string | Button color as six-digit hex. |
show_branding | Body | boolean | Whether the siz.la mark is shown. It can only be turned off on the plans that remove it. Needs Pro and the plans above it. |
Example request
curl -X PUT "https://siz.la/api/splash/7/update" \
-H "Authorization: Bearer $SIZLA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"seconds":8}'const response = await fetch("https://siz.la/api/splash/7/update", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.SIZLA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"seconds": 8
}),
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.put(
"https://siz.la/api/splash/7/update",
headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
json={
"seconds": 8,
},
)
print(response.json())$ch = curl_init('https://siz.la/api/splash/7/update');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer '.getenv('SIZLA_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'seconds' => 8,
]),
]);
$data = json_decode(curl_exec($ch), true);Example answer, status 200
{
"error": 0,
"id": 7,
"name": "Menu launch"
}Errors specific to this call
400: A value is not allowed.messagesays which.404: The splash page does not exist or belongs to someone else.
Delete a splash page
DELETE/api/splash/{id}/delete
Delete a splash page. Links that used it keep working and open without it.
Needs: API key with write access.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id (required) | Path | integer | The splash page's id. At least 1. |
Example request
curl -X DELETE "https://siz.la/api/splash/7/delete" \
-H "Authorization: Bearer $SIZLA_API_KEY"const response = await fetch("https://siz.la/api/splash/7/delete", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.SIZLA_API_KEY}`,
},
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.delete(
"https://siz.la/api/splash/7/delete",
headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
)
print(response.json())$ch = curl_init('https://siz.la/api/splash/7/delete');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer '.getenv('SIZLA_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);Example answer, status 200
{
"error": 0,
"message": "Splash page has been deleted successfully"
}Errors specific to this call
404: The splash page does not exist or belongs to someone else.