Overlays API
List the call-to-action messages on your account so you can show one over the page a link opens.
An overlay is a call-to-action message drawn over the page a link opens: a line of text and a button, with an optional picture. You make and edit overlays in the members area, under Call to action. The API lists them so you can pick one by id.
To show an overlay on a link, send its id as cta when you make or change the link (see (https://siz.la/docs/links)). The number of overlays you can keep depends on the plan.
List overlays
GET/api/overlay
Your call-to-action messages by name. Send an id as cta when you make or change a link.
Needs: API key.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | Query | integer | How many overlays 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/overlay?limit=10&page=1" \
-H "Authorization: Bearer $SIZLA_API_KEY"const response = await fetch("https://siz.la/api/overlay?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/overlay",
headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
params={
"limit": 10,
"page": 1,
},
)
print(response.json())$ch = curl_init('https://siz.la/api/overlay?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,
"cta": [
{
"id": 4,
"type": "banner",
"name": "Lunch deal",
"date": "2026-11-12 10:15:00"
}
]
}
}Notes
- Overlays are made and edited in the members area, under Call to action.
typeis one ofbanner,card,button.erroris the text"0"on this endpoint and the number0on the others.