{
    "openapi": "3.1.0",
    "info": {
        "title": "siz.la API",
        "version": "1.0.0",
        "summary": "Short links, click stats and conversions.",
        "description": "The siz.la REST API makes, reads, changes and deletes short links, exports clicks and records conversions. Every request carries an API key made under Settings, then Developers, in the members area. Requests are limited per minute by plan. Documentation: https://siz.la/docs",
        "contact": {
            "name": "siz.la",
            "url": "https://siz.la/contact"
        }
    },
    "servers": [
        {
            "url": "https://siz.la/api",
            "description": "siz.la"
        }
    ],
    "externalDocs": {
        "description": "Developer documentation",
        "url": "https://siz.la/docs"
    },
    "tags": [
        {
            "name": "Links",
            "description": "Make, find, change and delete short links."
        },
        {
            "name": "Campaigns",
            "description": "Group links to read their clicks together and give them shared UTM values."
        },
        {
            "name": "Domains",
            "description": "Connect your own domains and make short links on them."
        },
        {
            "name": "Pixels",
            "description": "Ad and analytics pixels that fire when someone clicks a link."
        },
        {
            "name": "Parameters",
            "description": "Saved sets of tracking parameters, the ones you pick in the link editor."
        },
        {
            "name": "QR codes",
            "description": "Make QR codes that stay editable and count scans."
        },
        {
            "name": "Overlays",
            "description": "The call-to-action messages you can show over the page a link opens."
        },
        {
            "name": "Channels",
            "description": "Keep links, QR codes and bio pages together, apart from campaigns."
        },
        {
            "name": "Splash pages",
            "description": "Pages shown for a few seconds before a link opens, with your own title and text."
        },
        {
            "name": "Account",
            "description": "Read the account a key belongs to, and change its email or password."
        },
        {
            "name": "Click export",
            "description": "Every click, one row each."
        },
        {
            "name": "Conversions",
            "description": "Count sign-ups and sales against the click that brought the visitor."
        },
        {
            "name": "Hook subscriptions",
            "description": "Let Zapier, Make, n8n or your own tool subscribe to events and stop again, without anyone pasting an address."
        },
        {
            "name": "Not available yet",
            "description": "Paths that exist and answer with status 501 until that part of the API is ready."
        }
    ],
    "security": [
        {
            "bearerAuth": []
        }
    ],
    "paths": {
        "/urls": {
            "get": {
                "operationId": "listLinks",
                "tags": [
                    "Links"
                ],
                "summary": "List links",
                "description": "Your links, newest first, with the number of clicks on each.\n\n`error` is the text `\"0\"` on this endpoint and the number `0` on the others. Compare it loosely or convert it first.\n\n`result` is the total number of links that match, not the number on this page.",
                "parameters": [
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "How many links to return on a page.",
                        "schema": {
                            "type": "integer",
                            "default": 15,
                            "minimum": 1,
                            "maximum": 100
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to return.",
                        "schema": {
                            "type": "integer",
                            "default": 1,
                            "minimum": 1
                        }
                    },
                    {
                        "name": "order",
                        "in": "query",
                        "required": false,
                        "description": "Newest first (`date`) or most clicked first (`click`).",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "date",
                                "click"
                            ],
                            "default": "date"
                        }
                    },
                    {
                        "name": "short",
                        "in": "query",
                        "required": false,
                        "description": "Find one link by its ending or its full short address.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "q",
                        "in": "query",
                        "required": false,
                        "description": "Text to look for in the destination, the ending and the title.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "string"
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "result": {
                                                    "type": "integer"
                                                },
                                                "perpage": {
                                                    "type": "integer"
                                                },
                                                "currentpage": {
                                                    "type": "integer"
                                                },
                                                "nextpage": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "maxpage": {
                                                    "type": "integer"
                                                },
                                                "urls": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "id": {
                                                                "type": "integer"
                                                            },
                                                            "alias": {
                                                                "type": "string"
                                                            },
                                                            "shorturl": {
                                                                "type": "string"
                                                            },
                                                            "longurl": {
                                                                "type": "string"
                                                            },
                                                            "clicks": {
                                                                "type": "integer"
                                                            },
                                                            "title": {
                                                                "type": "string"
                                                            },
                                                            "description": {
                                                                "type": "string"
                                                            },
                                                            "date": {
                                                                "type": "string"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": "0",
                                        "data": {
                                            "result": 1,
                                            "perpage": 10,
                                            "currentpage": 1,
                                            "nextpage": null,
                                            "maxpage": 1,
                                            "urls": [
                                                {
                                                    "id": 1042,
                                                    "alias": "lunch-menu",
                                                    "shorturl": "https://siz.la/lunch-menu",
                                                    "longurl": "https://example.com/a/long/address",
                                                    "clicks": 37,
                                                    "title": "",
                                                    "description": "",
                                                    "date": "2026-11-14 09:30:00"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/url/{id}": {
            "get": {
                "operationId": "getLink",
                "tags": [
                    "Links"
                ],
                "summary": "Get a link",
                "description": "One link with its settings and a summary of its clicks.\n\nA list in `data` (`topCountries` and the others) is the number `0` when there are no clicks to count.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The link's id, from the list or from the answer when it was made.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "details": {
                                            "type": "object",
                                            "properties": {
                                                "id": {
                                                    "type": "integer"
                                                },
                                                "shorturl": {
                                                    "type": "string"
                                                },
                                                "longurl": {
                                                    "type": "string"
                                                },
                                                "title": {
                                                    "type": "string"
                                                },
                                                "description": {
                                                    "type": "string"
                                                },
                                                "metaimage": {
                                                    "type": "string"
                                                },
                                                "location": {
                                                    "type": "object"
                                                },
                                                "device": {
                                                    "type": "object"
                                                },
                                                "expiry": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "splash": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "openinapp": {
                                                    "type": "boolean"
                                                },
                                                "blockbots": {
                                                    "type": "boolean"
                                                },
                                                "openinbrowser": {
                                                    "type": "boolean"
                                                },
                                                "app": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "date": {
                                                    "type": "string"
                                                }
                                            }
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "clicks": {
                                                    "type": "integer"
                                                },
                                                "uniqueClicks": {
                                                    "type": "integer"
                                                },
                                                "topCountries": {
                                                    "type": "object",
                                                    "properties": {
                                                        "US": {
                                                            "type": "integer"
                                                        },
                                                        "GB": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                },
                                                "topReferrers": {
                                                    "type": "object",
                                                    "properties": {
                                                        "t.co": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                },
                                                "topBrowsers": {
                                                    "type": "object",
                                                    "properties": {
                                                        "Chrome": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                },
                                                "topOs": {
                                                    "type": "object",
                                                    "properties": {
                                                        "iOS": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                },
                                                "socialCount": {
                                                    "type": "object",
                                                    "properties": {
                                                        "facebook": {
                                                            "type": "integer"
                                                        },
                                                        "twitter": {
                                                            "type": "integer"
                                                        },
                                                        "google": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 1042,
                                        "details": {
                                            "id": 1042,
                                            "shorturl": "https://siz.la/lunch-menu",
                                            "longurl": "https://example.com/a/long/address",
                                            "title": "",
                                            "description": "",
                                            "metaimage": "",
                                            "location": {},
                                            "device": {},
                                            "expiry": null,
                                            "splash": null,
                                            "openinapp": true,
                                            "blockbots": false,
                                            "openinbrowser": false,
                                            "app": null,
                                            "date": "2026-11-14 09:30:00"
                                        },
                                        "data": {
                                            "clicks": 37,
                                            "uniqueClicks": 31,
                                            "topCountries": {
                                                "US": 20,
                                                "GB": 7
                                            },
                                            "topReferrers": {
                                                "t.co": 9
                                            },
                                            "topBrowsers": {
                                                "Chrome": 22
                                            },
                                            "topOs": {
                                                "iOS": 14
                                            },
                                            "socialCount": {
                                                "facebook": 0,
                                                "twitter": 9,
                                                "google": 0
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The link does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/url/add": {
            "post": {
                "operationId": "createLink",
                "tags": [
                    "Links"
                ],
                "summary": "Shorten a link",
                "description": "Make a short link. The address is checked first, and your plan's monthly link limit applies.\n\n`pixels` and `channel` must be yours. The ids come from the pixels and channels lists.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "url": {
                                        "type": "string",
                                        "description": "The full web address to shorten. It must start with `http://` or `https://`."
                                    },
                                    "custom": {
                                        "type": "string",
                                        "description": "The ending you want, such as `lunch-menu`. Letters, numbers, dashes and underscores. Leave it out to get a random one. The shortest ending allowed on siz.la depends on the plan."
                                    },
                                    "domain": {
                                        "type": "string",
                                        "description": "One of your connected custom domains, as the host name (`go.example.com`) or its id. Leave it out to use siz.la."
                                    },
                                    "password": {
                                        "type": "string",
                                        "description": "A password visitors must enter before they are sent on. On update, send an empty string to remove it. ."
                                    },
                                    "expiry": {
                                        "type": "string",
                                        "description": "When the link stops working, as a date and time in the future such as `2026-12-31 18:00`. On update, send an empty string to remove it. ."
                                    },
                                    "campaign": {
                                        "type": "string",
                                        "description": "A campaign to put the link in, by id or by name. A name that does not exist yet makes a new campaign. Needs Pro and the plans above it."
                                    },
                                    "cta": {
                                        "type": "integer",
                                        "description": "One of your call-to-action messages, by id, to show over the page the link opens. On update, send `0` to remove it."
                                    },
                                    "pixels": {
                                        "type": "array",
                                        "items": {
                                            "type": "object"
                                        },
                                        "description": "The ids of your ad pixels to fire on each click, from the pixels list. On update, an empty list removes them all and leaving it out keeps them. ."
                                    },
                                    "channel": {
                                        "type": "string",
                                        "description": "A channel to put the link in, by id or by name. On update, send an empty string to take it out."
                                    },
                                    "splash": {
                                        "type": "integer",
                                        "description": "One of your splash pages, by id, to show for a few seconds before the page opens. A link shows a splash page or a call to action, not both. On update, send `0` to remove it."
                                    },
                                    "openinapp": {
                                        "type": "boolean",
                                        "default": true,
                                        "description": "Open the app on a phone when the address belongs to a known app, such as YouTube or Spotify, and the app is installed. On by default for every plan; send `false` to always open the web page. An app address you set with `deeplink` is used first."
                                    },
                                    "blockbots": {
                                        "type": "boolean",
                                        "default": false,
                                        "description": "Answer crawlers and scripts with a plain \"not found\" page instead of the redirect. Their visits are not counted. Chat apps that fetch a card still get it when the link has a preview. Leave it out on update to keep what the link has."
                                    },
                                    "openinbrowser": {
                                        "type": "boolean",
                                        "default": false,
                                        "description": "Show people inside the Instagram, TikTok or Facebook app a page that helps them open the link in their own browser. The visit is counted when they do. Leave it out on update to keep what the link has."
                                    },
                                    "metatitle": {
                                        "type": "string",
                                        "maxLength": 191,
                                        "description": "The title shown when the link is shared in a chat app or on a social site. Send an empty string to remove it. ."
                                    },
                                    "metadescription": {
                                        "type": "string",
                                        "maxLength": 500,
                                        "description": "The description shown when the link is shared. Send an empty string to remove it. ."
                                    },
                                    "metaimage": {
                                        "type": "string",
                                        "maxLength": 191,
                                        "description": "The address of the picture shown when the link is shared. It must start with `https://` or `http://`. Send an empty string to remove it. ."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "A private note. Only you see it."
                                    },
                                    "geotarget": {
                                        "type": "array",
                                        "items": {
                                            "type": "object"
                                        },
                                        "description": "Send visitors from some countries somewhere else: a list of objects with `location` (a country name or two-letter code) and `link` (the address). ."
                                    },
                                    "devicetarget": {
                                        "type": "array",
                                        "items": {
                                            "type": "object"
                                        },
                                        "description": "Send some devices somewhere else: a list of objects with `device` (`ios`, `android`, `windows`, `macos` or `linux`) and `link`. ."
                                    },
                                    "languagetarget": {
                                        "type": "array",
                                        "items": {
                                            "type": "object"
                                        },
                                        "description": "Send some browser languages somewhere else: a list of objects with `language` (a two-letter code) and `link`. ."
                                    },
                                    "deeplink": {
                                        "type": "object",
                                        "description": "Send phones to an app or store address of your own instead of the web address: an object with `apple` and `google` addresses. Links to well-known apps open the app without this; see `openinapp`. ."
                                    },
                                    "type": {
                                        "type": "string",
                                        "enum": [
                                            "direct"
                                        ],
                                        "description": "Only `direct` is available. Any other value is refused."
                                    }
                                },
                                "required": [
                                    "url"
                                ],
                                "example": {
                                    "url": "https://example.com/a/long/address",
                                    "custom": "lunch-menu"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "shorturl": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 1042,
                                        "shorturl": "https://siz.la/lunch-menu"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "The address is not allowed, the ending is taken or not allowed, an option needs a different plan, or the monthly link limit is used up. `message` says which.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/url/{id}/update": {
            "put": {
                "operationId": "updateLink",
                "tags": [
                    "Links"
                ],
                "summary": "Update a link",
                "description": "Change a link. Only the fields you send change.\n\nThe short address in the answer is under `short` here, and under `shorturl` when a link is made.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The link's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "url": {
                                        "type": "string",
                                        "description": "The new full web address the link leads to."
                                    },
                                    "custom": {
                                        "type": "string",
                                        "description": "The ending you want, such as `lunch-menu`. Letters, numbers, dashes and underscores. Leave it out to get a random one. The shortest ending allowed on siz.la depends on the plan."
                                    },
                                    "domain": {
                                        "type": "string",
                                        "description": "One of your connected custom domains, as the host name (`go.example.com`) or its id. Leave it out to use siz.la."
                                    },
                                    "password": {
                                        "type": "string",
                                        "description": "A password visitors must enter before they are sent on. On update, send an empty string to remove it. ."
                                    },
                                    "expiry": {
                                        "type": "string",
                                        "description": "When the link stops working, as a date and time in the future such as `2026-12-31 18:00`. On update, send an empty string to remove it. ."
                                    },
                                    "campaign": {
                                        "type": "string",
                                        "description": "A campaign to put the link in, by id or by name. A name that does not exist yet makes a new campaign. Needs Pro and the plans above it."
                                    },
                                    "cta": {
                                        "type": "integer",
                                        "description": "One of your call-to-action messages, by id, to show over the page the link opens. On update, send `0` to remove it."
                                    },
                                    "pixels": {
                                        "type": "array",
                                        "items": {
                                            "type": "object"
                                        },
                                        "description": "The ids of your ad pixels to fire on each click, from the pixels list. On update, an empty list removes them all and leaving it out keeps them. ."
                                    },
                                    "channel": {
                                        "type": "string",
                                        "description": "A channel to put the link in, by id or by name. On update, send an empty string to take it out."
                                    },
                                    "splash": {
                                        "type": "integer",
                                        "description": "One of your splash pages, by id, to show for a few seconds before the page opens. A link shows a splash page or a call to action, not both. On update, send `0` to remove it."
                                    },
                                    "openinapp": {
                                        "type": "boolean",
                                        "default": true,
                                        "description": "Open the app on a phone when the address belongs to a known app, such as YouTube or Spotify, and the app is installed. On by default for every plan; send `false` to always open the web page. An app address you set with `deeplink` is used first."
                                    },
                                    "blockbots": {
                                        "type": "boolean",
                                        "default": false,
                                        "description": "Answer crawlers and scripts with a plain \"not found\" page instead of the redirect. Their visits are not counted. Chat apps that fetch a card still get it when the link has a preview. Leave it out on update to keep what the link has."
                                    },
                                    "openinbrowser": {
                                        "type": "boolean",
                                        "default": false,
                                        "description": "Show people inside the Instagram, TikTok or Facebook app a page that helps them open the link in their own browser. The visit is counted when they do. Leave it out on update to keep what the link has."
                                    },
                                    "metatitle": {
                                        "type": "string",
                                        "maxLength": 191,
                                        "description": "The title shown when the link is shared in a chat app or on a social site. Send an empty string to remove it. ."
                                    },
                                    "metadescription": {
                                        "type": "string",
                                        "maxLength": 500,
                                        "description": "The description shown when the link is shared. Send an empty string to remove it. ."
                                    },
                                    "metaimage": {
                                        "type": "string",
                                        "maxLength": 191,
                                        "description": "The address of the picture shown when the link is shared. It must start with `https://` or `http://`. Send an empty string to remove it. ."
                                    },
                                    "description": {
                                        "type": "string",
                                        "description": "A private note. Only you see it."
                                    },
                                    "geotarget": {
                                        "type": "array",
                                        "items": {
                                            "type": "object"
                                        },
                                        "description": "Send visitors from some countries somewhere else: a list of objects with `location` (a country name or two-letter code) and `link` (the address). ."
                                    },
                                    "devicetarget": {
                                        "type": "array",
                                        "items": {
                                            "type": "object"
                                        },
                                        "description": "Send some devices somewhere else: a list of objects with `device` (`ios`, `android`, `windows`, `macos` or `linux`) and `link`. ."
                                    },
                                    "languagetarget": {
                                        "type": "array",
                                        "items": {
                                            "type": "object"
                                        },
                                        "description": "Send some browser languages somewhere else: a list of objects with `language` (a two-letter code) and `link`. ."
                                    },
                                    "deeplink": {
                                        "type": "object",
                                        "description": "Send phones to an app or store address of your own instead of the web address: an object with `apple` and `google` addresses. Links to well-known apps open the app without this; see `openinapp`. ."
                                    },
                                    "type": {
                                        "type": "string",
                                        "enum": [
                                            "direct"
                                        ],
                                        "description": "Only `direct` is available. Any other value is refused."
                                    }
                                },
                                "example": {
                                    "url": "https://example.com/new-address"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "short": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 1042,
                                        "short": "https://siz.la/lunch-menu"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A value is not allowed. `message` says which.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The link does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/url/{id}/delete": {
            "delete": {
                "operationId": "deleteLink",
                "tags": [
                    "Links"
                ],
                "summary": "Delete a link",
                "description": "Delete a link and its click history for good. The short address stops working and cannot be used again.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The link's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Link has been deleted successfully"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The link does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/campaigns": {
            "get": {
                "operationId": "listCampaigns",
                "tags": [
                    "Campaigns"
                ],
                "summary": "List campaigns",
                "description": "Your campaigns by name, with how many links each holds and its clicks over the last 30 days.\n\n`error` is the text `\"0\"` on this endpoint and the number `0` on the others.\n\nNeeds Pro and the plans above it.",
                "parameters": [
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "How many campaigns to return on a page.",
                        "schema": {
                            "type": "integer",
                            "default": 15,
                            "minimum": 1,
                            "maximum": 100
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to return.",
                        "schema": {
                            "type": "integer",
                            "default": 1,
                            "minimum": 1
                        }
                    },
                    {
                        "name": "q",
                        "in": "query",
                        "required": false,
                        "description": "Text to look for in the name.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "string"
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "result": {
                                                    "type": "integer"
                                                },
                                                "perpage": {
                                                    "type": "integer"
                                                },
                                                "currentpage": {
                                                    "type": "integer"
                                                },
                                                "nextpage": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "maxpage": {
                                                    "type": "integer"
                                                },
                                                "campaigns": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "id": {
                                                                "type": "integer"
                                                            },
                                                            "name": {
                                                                "type": "string"
                                                            },
                                                            "color": {
                                                                "type": "string"
                                                            },
                                                            "utm_source": {
                                                                "type": "string"
                                                            },
                                                            "utm_medium": {
                                                                "type": "string"
                                                            },
                                                            "utm_campaign": {
                                                                "type": "string"
                                                            },
                                                            "links": {
                                                                "type": "integer"
                                                            },
                                                            "clicks": {
                                                                "type": "integer"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": "0",
                                        "data": {
                                            "result": 1,
                                            "perpage": 10,
                                            "currentpage": 1,
                                            "nextpage": null,
                                            "maxpage": 1,
                                            "campaigns": [
                                                {
                                                    "id": 12,
                                                    "name": "Summer menu",
                                                    "color": "ember",
                                                    "utm_source": "newsletter",
                                                    "utm_medium": "email",
                                                    "utm_campaign": "summer-menu",
                                                    "links": 8,
                                                    "clicks": 412
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include campaigns.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/campaign/{id}": {
            "get": {
                "operationId": "getCampaign",
                "tags": [
                    "Campaigns"
                ],
                "summary": "Get a campaign",
                "description": "One campaign with its settings, its clicks and where they came from.\n\nA list in `data` is the number `0` when there are no clicks to count.\n\nNeeds Pro and the plans above it.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The campaign's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    },
                    {
                        "name": "days",
                        "in": "query",
                        "required": false,
                        "description": "How many days back to report. The plan may keep less history than that.",
                        "schema": {
                            "type": "integer",
                            "enum": [
                                7,
                                30,
                                90
                            ],
                            "default": 30
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "details": {
                                            "type": "object",
                                            "properties": {
                                                "id": {
                                                    "type": "integer"
                                                },
                                                "name": {
                                                    "type": "string"
                                                },
                                                "color": {
                                                    "type": "string"
                                                },
                                                "utm_source": {
                                                    "type": "string"
                                                },
                                                "utm_medium": {
                                                    "type": "string"
                                                },
                                                "utm_campaign": {
                                                    "type": "string"
                                                },
                                                "links": {
                                                    "type": "integer"
                                                },
                                                "date": {
                                                    "type": "string"
                                                }
                                            }
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "days": {
                                                    "type": "integer"
                                                },
                                                "clicks": {
                                                    "type": "integer"
                                                },
                                                "uniqueClicks": {
                                                    "type": "integer"
                                                },
                                                "topCountries": {
                                                    "type": "object",
                                                    "properties": {
                                                        "US": {
                                                            "type": "integer"
                                                        },
                                                        "GB": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                },
                                                "topReferrers": {
                                                    "type": "object",
                                                    "properties": {
                                                        "t.co": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                },
                                                "topDevices": {
                                                    "type": "object",
                                                    "properties": {
                                                        "mobile": {
                                                            "type": "integer"
                                                        },
                                                        "desktop": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                },
                                                "topLinks": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "id": {
                                                                "type": "integer"
                                                            },
                                                            "shorturl": {
                                                                "type": "string"
                                                            },
                                                            "clicks": {
                                                                "type": "integer"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 12,
                                        "details": {
                                            "id": 12,
                                            "name": "Summer menu",
                                            "color": "ember",
                                            "utm_source": "newsletter",
                                            "utm_medium": "email",
                                            "utm_campaign": "summer-menu",
                                            "links": 8,
                                            "date": "2026-11-10 08:00:00"
                                        },
                                        "data": {
                                            "days": 30,
                                            "clicks": 412,
                                            "uniqueClicks": 355,
                                            "topCountries": {
                                                "US": 240,
                                                "GB": 61
                                            },
                                            "topReferrers": {
                                                "t.co": 90
                                            },
                                            "topDevices": {
                                                "mobile": 301,
                                                "desktop": 111
                                            },
                                            "topLinks": [
                                                {
                                                    "id": 1042,
                                                    "shorturl": "https://siz.la/lunch-menu",
                                                    "clicks": 37
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include campaigns.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "The campaign does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/campaign/add": {
            "post": {
                "operationId": "createCampaign",
                "tags": [
                    "Campaigns"
                ],
                "summary": "Make a campaign",
                "description": "Make a campaign. Put links in it with the `campaign` option on a link or with the assign call.\n\nNeeds Pro and the plans above it.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "maxLength": 80,
                                        "description": "The campaign's name. It must be different from your other campaigns."
                                    },
                                    "color": {
                                        "type": "string",
                                        "enum": [
                                            "ink",
                                            "ember",
                                            "sky",
                                            "mint",
                                            "lilac",
                                            "butter",
                                            "blush",
                                            "slate"
                                        ],
                                        "description": "The color of the campaign's dot in the members area. The default is `ink`."
                                    },
                                    "utm_source": {
                                        "type": "string",
                                        "maxLength": 100,
                                        "description": "Added to the address of every link in the campaign as `utm_source`. Send an empty string to remove it."
                                    },
                                    "utm_medium": {
                                        "type": "string",
                                        "maxLength": 100,
                                        "description": "Added as `utm_medium`."
                                    },
                                    "utm_campaign": {
                                        "type": "string",
                                        "maxLength": 100,
                                        "description": "Added as `utm_campaign`."
                                    }
                                },
                                "required": [
                                    "name"
                                ],
                                "example": {
                                    "name": "Summer menu",
                                    "utm_source": "newsletter",
                                    "utm_medium": "email"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "name": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 12,
                                        "name": "Summer menu"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "The name is missing or already used, a value is not allowed, or the account has the most campaigns it can keep.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include campaigns.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/campaign/{id}/update": {
            "put": {
                "operationId": "updateCampaign",
                "tags": [
                    "Campaigns"
                ],
                "summary": "Update a campaign",
                "description": "Change a campaign. Only the fields you send change. New UTM values reach a link the next time it is saved or added to the campaign.\n\nNeeds Pro and the plans above it.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The campaign's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "maxLength": 80,
                                        "description": "The campaign's name. It must be different from your other campaigns."
                                    },
                                    "color": {
                                        "type": "string",
                                        "enum": [
                                            "ink",
                                            "ember",
                                            "sky",
                                            "mint",
                                            "lilac",
                                            "butter",
                                            "blush",
                                            "slate"
                                        ],
                                        "description": "The color of the campaign's dot in the members area. The default is `ink`."
                                    },
                                    "utm_source": {
                                        "type": "string",
                                        "maxLength": 100,
                                        "description": "Added to the address of every link in the campaign as `utm_source`. Send an empty string to remove it."
                                    },
                                    "utm_medium": {
                                        "type": "string",
                                        "maxLength": 100,
                                        "description": "Added as `utm_medium`."
                                    },
                                    "utm_campaign": {
                                        "type": "string",
                                        "maxLength": 100,
                                        "description": "Added as `utm_campaign`."
                                    }
                                },
                                "example": {
                                    "utm_campaign": "summer-menu-2026"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "name": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 12,
                                        "name": "Summer menu"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A value is not allowed. `message` says which.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include campaigns.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "The campaign does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/campaign/{id}/delete": {
            "delete": {
                "operationId": "deleteCampaign",
                "tags": [
                    "Campaigns"
                ],
                "summary": "Delete a campaign",
                "description": "Delete a campaign. Its links keep working and leave the campaign.\n\nNeeds Pro and the plans above it.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The campaign's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Campaign has been deleted successfully"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include campaigns.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "The campaign does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/campaign/{id}/assign/{link}": {
            "post": {
                "operationId": "assignLinkToCampaign",
                "tags": [
                    "Campaigns"
                ],
                "summary": "Put a link in a campaign",
                "description": "Move one of your links into a campaign. The campaign's UTM values are added to the link's address.\n\nTo take a link out of a campaign, update the link with an empty `campaign`.\n\nNeeds Pro and the plans above it.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The campaign's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    },
                    {
                        "name": "link",
                        "in": "path",
                        "required": true,
                        "description": "The link's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Link has been assigned to the campaign."
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include campaigns.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "The campaign or the link does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/domains": {
            "get": {
                "operationId": "listDomains",
                "tags": [
                    "Domains"
                ],
                "summary": "List domains",
                "description": "Your custom domains by name, with where the bare domain and unknown endings send people.\n\n`status` is `pending` until the DNS records are in place, `active` while links work on the domain and `failed` when the records stop pointing here. Only an `active` domain can be used on a link.\n\n`error` is the text `\"0\"` on this endpoint and the number `0` on the others.",
                "parameters": [
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "How many domains to return on a page.",
                        "schema": {
                            "type": "integer",
                            "default": 15,
                            "minimum": 1,
                            "maximum": 100
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to return.",
                        "schema": {
                            "type": "integer",
                            "default": 1,
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "string"
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "result": {
                                                    "type": "integer"
                                                },
                                                "perpage": {
                                                    "type": "integer"
                                                },
                                                "currentpage": {
                                                    "type": "integer"
                                                },
                                                "nextpage": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "maxpage": {
                                                    "type": "integer"
                                                },
                                                "domains": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "id": {
                                                                "type": "integer"
                                                            },
                                                            "domain": {
                                                                "type": "string"
                                                            },
                                                            "redirectroot": {
                                                                "type": "string"
                                                            },
                                                            "redirect404": {
                                                                "type": "string"
                                                            },
                                                            "status": {
                                                                "type": "string"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": "0",
                                        "data": {
                                            "result": 1,
                                            "perpage": 10,
                                            "currentpage": 1,
                                            "nextpage": null,
                                            "maxpage": 1,
                                            "domains": [
                                                {
                                                    "id": 31,
                                                    "domain": "go.example.com",
                                                    "redirectroot": "https://example.com",
                                                    "redirect404": "https://example.com/not-found",
                                                    "status": "active"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/domain/add": {
            "post": {
                "operationId": "createDomain",
                "tags": [
                    "Domains"
                ],
                "summary": "Add a domain",
                "description": "Add a domain or subdomain you own. The answer lists the two DNS records to add where its DNS is managed. Then call the check endpoint, or wait: domains are checked on their own every few minutes.\n\nThe number of domains depends on the plan.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "domain": {
                                        "type": "string",
                                        "description": "The domain, such as `go.example.com`. A scheme, path or port is dropped."
                                    },
                                    "redirectroot": {
                                        "type": "string",
                                        "description": "Where the bare domain sends visitors. It must start with `http://` or `https://`."
                                    },
                                    "redirect404": {
                                        "type": "string",
                                        "description": "Where an ending that does not exist sends visitors."
                                    }
                                },
                                "required": [
                                    "domain"
                                ],
                                "example": {
                                    "domain": "go.example.com",
                                    "redirectroot": "https://example.com"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "400": {
                        "description": "The domain is not a valid name, is siz.la itself, belongs to another account, or the account has the most domains its plan allows. `message` says which.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    },
                    "pending": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "domain": {
                                            "type": "string"
                                        },
                                        "status": {
                                            "type": "string"
                                        },
                                        "records": {
                                            "type": "object",
                                            "properties": {
                                                "cname": {
                                                    "type": "object",
                                                    "properties": {
                                                        "type": {
                                                            "type": "string"
                                                        },
                                                        "name": {
                                                            "type": "string"
                                                        },
                                                        "value": {
                                                            "type": "string"
                                                        }
                                                    }
                                                },
                                                "txt": {
                                                    "type": "object",
                                                    "properties": {
                                                        "type": {
                                                            "type": "string"
                                                        },
                                                        "name": {
                                                            "type": "string"
                                                        },
                                                        "value": {
                                                            "type": "string"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 31,
                                        "domain": "go.example.com",
                                        "status": "pending",
                                        "records": {
                                            "cname": {
                                                "type": "CNAME",
                                                "name": "go.example.com",
                                                "value": "connect.siz.la"
                                            },
                                            "txt": {
                                                "type": "TXT",
                                                "name": "_sizla.go.example.com",
                                                "value": "sizla-verify=0123456789abcdef0123456789abcdef"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/domain/{id}/update": {
            "put": {
                "operationId": "updateDomain",
                "tags": [
                    "Domains"
                ],
                "summary": "Update a domain",
                "description": "Change where the bare domain and unknown endings lead. Only the fields you send change.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The domain's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "redirectroot": {
                                        "type": "string",
                                        "description": "Where the bare domain sends visitors. Send an empty string to remove it."
                                    },
                                    "redirect404": {
                                        "type": "string",
                                        "description": "Where an ending that does not exist sends visitors. Send an empty string to remove it."
                                    }
                                },
                                "example": {
                                    "redirect404": "https://example.com/not-found"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Domain has been updated successfully"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "An address is not allowed. `message` says which.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The domain does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/domain/{id}/check": {
            "post": {
                "operationId": "checkDomain",
                "tags": [
                    "Domains"
                ],
                "summary": "Check a domain",
                "description": "Look for the DNS records now and turn the domain on when they are right. `problem` says what is still missing.\n\nDNS changes can take a few minutes to an hour to show.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The domain's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The domain does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    },
                    "active": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "status": {
                                            "type": "string"
                                        },
                                        "problem": {
                                            "type": [
                                                "string",
                                                "null"
                                            ]
                                        },
                                        "records": {
                                            "type": "object",
                                            "properties": {
                                                "cname": {
                                                    "type": "object",
                                                    "properties": {
                                                        "type": {
                                                            "type": "string"
                                                        },
                                                        "name": {
                                                            "type": "string"
                                                        },
                                                        "value": {
                                                            "type": "string"
                                                        }
                                                    }
                                                },
                                                "txt": {
                                                    "type": "object",
                                                    "properties": {
                                                        "type": {
                                                            "type": "string"
                                                        },
                                                        "name": {
                                                            "type": "string"
                                                        },
                                                        "value": {
                                                            "type": "string"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 31,
                                        "status": "active",
                                        "problem": null,
                                        "records": {
                                            "cname": {
                                                "type": "CNAME",
                                                "name": "go.example.com",
                                                "value": "connect.siz.la"
                                            },
                                            "txt": {
                                                "type": "TXT",
                                                "name": "_sizla.go.example.com",
                                                "value": "sizla-verify=0123456789abcdef0123456789abcdef"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/domain/{id}/delete": {
            "delete": {
                "operationId": "deleteDomain",
                "tags": [
                    "Domains"
                ],
                "summary": "Delete a domain",
                "description": "Remove a domain. A domain that still has links is refused: move them to another domain or delete them first.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The domain's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Domain has been deleted successfully"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "The domain still has links.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The domain does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/pixels": {
            "get": {
                "operationId": "listPixels",
                "tags": [
                    "Pixels"
                ],
                "summary": "List pixels",
                "description": "Your pixels by name. Send their ids as `pixels` when you make or change a link.\n\n`error` is the text `\"0\"` on this endpoint and the number `0` on the others.",
                "parameters": [
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "How many pixels to return on a page.",
                        "schema": {
                            "type": "integer",
                            "default": 15,
                            "minimum": 1,
                            "maximum": 100
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to return.",
                        "schema": {
                            "type": "integer",
                            "default": 1,
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "string"
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "result": {
                                                    "type": "integer"
                                                },
                                                "perpage": {
                                                    "type": "integer"
                                                },
                                                "currentpage": {
                                                    "type": "integer"
                                                },
                                                "nextpage": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "maxpage": {
                                                    "type": "integer"
                                                },
                                                "pixels": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "id": {
                                                                "type": "integer"
                                                            },
                                                            "type": {
                                                                "type": "string"
                                                            },
                                                            "name": {
                                                                "type": "string"
                                                            },
                                                            "tag": {
                                                                "type": "string"
                                                            },
                                                            "date": {
                                                                "type": "string"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": "0",
                                        "data": {
                                            "result": 1,
                                            "perpage": 10,
                                            "currentpage": 1,
                                            "nextpage": null,
                                            "maxpage": 1,
                                            "pixels": [
                                                {
                                                    "id": 9,
                                                    "type": "meta",
                                                    "name": "Spring campaign",
                                                    "tag": "123456789012345",
                                                    "date": "2026-11-12 08:20:00"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include pixels.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/pixel/add": {
            "post": {
                "operationId": "createPixel",
                "tags": [
                    "Pixels"
                ],
                "summary": "Add a pixel",
                "description": "Add a pixel. The id is checked against the format of the type you pick.\n\nIds by type: `meta` is the pixel id, all digits, from Events Manager; `google_ads` is the conversion id that starts with AW-; `ga4` is the measurement id that starts with G-; `tiktok` is the pixel id from TikTok Events Manager; `linkedin` is the Insight Tag partner id, all digits; `pinterest` is the tag id, all digits, from Pinterest Ads; `x` is the pixel id from X Ads events manager; `snapchat` is the pixel id from Snapchat Ads Manager, with its dashes; `microsoft` is the UET tag id, all digits; `reddit` is the pixel id from Reddit Ads, starting with t2_ or a2_; `quora` is the pixel id from Quora Ads Manager, 32 letters and digits.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type": {
                                        "type": "string",
                                        "enum": [
                                            "meta",
                                            "google_ads",
                                            "ga4",
                                            "tiktok",
                                            "linkedin",
                                            "pinterest",
                                            "x",
                                            "snapchat",
                                            "microsoft",
                                            "reddit",
                                            "quora"
                                        ],
                                        "description": "Where the pixel reports to."
                                    },
                                    "name": {
                                        "type": "string",
                                        "maxLength": 80,
                                        "description": "A name for you. Only you see it."
                                    },
                                    "tag": {
                                        "type": "string",
                                        "maxLength": 60,
                                        "description": "The pixel id from the provider. It must fit the format of the type."
                                    }
                                },
                                "required": [
                                    "type",
                                    "name",
                                    "tag"
                                ],
                                "example": {
                                    "type": "meta",
                                    "name": "Spring campaign",
                                    "tag": "123456789012345"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 9
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "The type or id is not valid, you already have that pixel, or the account has the most pixels it can keep. `message` says which.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include pixels.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/pixel/{id}/update": {
            "put": {
                "operationId": "updatePixel",
                "tags": [
                    "Pixels"
                ],
                "summary": "Update a pixel",
                "description": "Change a pixel. Only the fields you send change. Links that use it fire the new id from then on.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The pixel's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type": {
                                        "type": "string",
                                        "enum": [
                                            "meta",
                                            "google_ads",
                                            "ga4",
                                            "tiktok",
                                            "linkedin",
                                            "pinterest",
                                            "x",
                                            "snapchat",
                                            "microsoft",
                                            "reddit",
                                            "quora"
                                        ],
                                        "description": "Where the pixel reports to."
                                    },
                                    "name": {
                                        "type": "string",
                                        "maxLength": 80,
                                        "description": "A name for you. Only you see it."
                                    },
                                    "tag": {
                                        "type": "string",
                                        "maxLength": 60,
                                        "description": "The pixel id from the provider. It must fit the format of the type."
                                    }
                                },
                                "example": {
                                    "name": "Spring campaign 2026"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Pixel has been updated successfully"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A value is not valid. `message` says which.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include pixels.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "The pixel does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/pixel/{id}/delete": {
            "delete": {
                "operationId": "deletePixel",
                "tags": [
                    "Pixels"
                ],
                "summary": "Delete a pixel",
                "description": "Delete a pixel. Every link that used it stops firing it.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The pixel's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Pixel has been deleted successfully"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include pixels.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "The pixel does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/parameters": {
            "get": {
                "operationId": "listParameters",
                "tags": [
                    "Parameters"
                ],
                "summary": "List saved parameters",
                "description": "Your saved parameter sets by name. `params` holds the names and values a set adds to a link's address. Send them as `params` when you make or change a link.\n\n`error` is the text `\"0\"` on this endpoint and the number `0` on the others.",
                "parameters": [
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "How many sets to return on a page.",
                        "schema": {
                            "type": "integer",
                            "default": 15,
                            "minimum": 1,
                            "maximum": 100
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to return.",
                        "schema": {
                            "type": "integer",
                            "default": 1,
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "string"
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "result": {
                                                    "type": "integer"
                                                },
                                                "perpage": {
                                                    "type": "integer"
                                                },
                                                "currentpage": {
                                                    "type": "integer"
                                                },
                                                "nextpage": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "maxpage": {
                                                    "type": "integer"
                                                },
                                                "parameters": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "id": {
                                                                "type": "integer"
                                                            },
                                                            "name": {
                                                                "type": "string"
                                                            },
                                                            "params": {
                                                                "type": "object",
                                                                "properties": {
                                                                    "utm_source": {
                                                                        "type": "string"
                                                                    },
                                                                    "utm_medium": {
                                                                        "type": "string"
                                                                    }
                                                                }
                                                            },
                                                            "date": {
                                                                "type": "string"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": "0",
                                        "data": {
                                            "result": 1,
                                            "perpage": 10,
                                            "currentpage": 1,
                                            "nextpage": null,
                                            "maxpage": 1,
                                            "parameters": [
                                                {
                                                    "id": 4,
                                                    "name": "Monthly newsletter",
                                                    "params": {
                                                        "utm_source": "newsletter",
                                                        "utm_medium": "email"
                                                    },
                                                    "date": "2026-11-12 08:20:00"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include saved parameters.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/qr": {
            "get": {
                "operationId": "listQrCodes",
                "tags": [
                    "QR codes"
                ],
                "summary": "List QR codes",
                "description": "Your QR codes, newest first, with how many times each was scanned.\n\n`link` is the short address a dynamic code points through. It is an empty string for a static code, which holds its content directly, and `scans` is `null` for it because a static code cannot be counted.\n\n`error` is the text `\"0\"` on this endpoint and the number `0` on the others.",
                "parameters": [
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "How many codes to return on a page.",
                        "schema": {
                            "type": "integer",
                            "default": 15,
                            "minimum": 1,
                            "maximum": 100
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to return.",
                        "schema": {
                            "type": "integer",
                            "default": 1,
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "string"
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "result": {
                                                    "type": "integer"
                                                },
                                                "perpage": {
                                                    "type": "integer"
                                                },
                                                "currentpage": {
                                                    "type": "integer"
                                                },
                                                "nextpage": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "maxpage": {
                                                    "type": "integer"
                                                },
                                                "qrs": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "id": {
                                                                "type": "integer"
                                                            },
                                                            "link": {
                                                                "type": "string"
                                                            },
                                                            "scans": {
                                                                "type": "integer"
                                                            },
                                                            "name": {
                                                                "type": "string"
                                                            },
                                                            "date": {
                                                                "type": "string"
                                                            },
                                                            "type": {
                                                                "type": "string"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": "0",
                                        "data": {
                                            "result": 1,
                                            "perpage": 10,
                                            "currentpage": 1,
                                            "nextpage": null,
                                            "maxpage": 1,
                                            "qrs": [
                                                {
                                                    "id": 77,
                                                    "link": "https://siz.la/menu-qr",
                                                    "scans": 58,
                                                    "name": "Table cards",
                                                    "date": "2026-11-13 12:00:00",
                                                    "type": "link"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/qr/{id}": {
            "get": {
                "operationId": "getQrCode",
                "tags": [
                    "QR codes"
                ],
                "summary": "Get a QR code",
                "description": "One QR code with its content and colors, and a summary of the visits through its link.\n\nA list in `data` is the number `0` when there is nothing to count. A static code has no link behind it, so all of `data` is `0`.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The code's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "details": {
                                            "type": "object",
                                            "properties": {
                                                "id": {
                                                    "type": "integer"
                                                },
                                                "link": {
                                                    "type": "string"
                                                },
                                                "scans": {
                                                    "type": "integer"
                                                },
                                                "name": {
                                                    "type": "string"
                                                },
                                                "date": {
                                                    "type": "string"
                                                },
                                                "type": {
                                                    "type": "string"
                                                },
                                                "foreground": {
                                                    "type": "string"
                                                },
                                                "background": {
                                                    "type": "string"
                                                },
                                                "fields": {
                                                    "type": "object",
                                                    "properties": {
                                                        "url": {
                                                            "type": "string"
                                                        }
                                                    }
                                                }
                                            }
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "clicks": {
                                                    "type": "integer"
                                                },
                                                "uniqueClicks": {
                                                    "type": "integer"
                                                },
                                                "topCountries": {
                                                    "type": "object",
                                                    "properties": {
                                                        "US": {
                                                            "type": "integer"
                                                        },
                                                        "GB": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                },
                                                "topReferrers": {
                                                    "type": "integer"
                                                },
                                                "topBrowsers": {
                                                    "type": "object",
                                                    "properties": {
                                                        "Safari": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                },
                                                "topOs": {
                                                    "type": "object",
                                                    "properties": {
                                                        "iOS": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                },
                                                "socialCount": {
                                                    "type": "object",
                                                    "properties": {
                                                        "facebook": {
                                                            "type": "integer"
                                                        },
                                                        "twitter": {
                                                            "type": "integer"
                                                        },
                                                        "instagram": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "details": {
                                            "id": 77,
                                            "link": "https://siz.la/menu-qr",
                                            "scans": 58,
                                            "name": "Table cards",
                                            "date": "2026-11-13 12:00:00",
                                            "type": "link",
                                            "foreground": "#17171a",
                                            "background": "#ffffff",
                                            "fields": {
                                                "url": "https://example.com/menu"
                                            }
                                        },
                                        "data": {
                                            "clicks": 58,
                                            "uniqueClicks": 49,
                                            "topCountries": {
                                                "US": 31,
                                                "GB": 12
                                            },
                                            "topReferrers": 0,
                                            "topBrowsers": {
                                                "Safari": 40
                                            },
                                            "topOs": {
                                                "iOS": 38
                                            },
                                            "socialCount": {
                                                "facebook": 0,
                                                "twitter": 0,
                                                "instagram": 4
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The code does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/qr/add": {
            "post": {
                "operationId": "createQrCode",
                "tags": [
                    "QR codes"
                ],
                "summary": "Make a QR code",
                "description": "Make a QR code. Dynamic types make a short link behind the code, so the destination can change later and scans are counted. Your plan's monthly QR code limit applies.\n\nTypes and their fields: `text` takes `text` (the main one); `sms` takes `phone` (the main one), `message`; `wifi` takes `ssid` (the main one), `security`, `password`, `hidden`; `vcard` takes `first_name` (the main one), `last_name`, `organization`, `job_title`, `phone`, `email`, `website`, `address`; `event` takes `title` (the main one), `starts_at`, `ends_at`, `location`, `description`; `link` takes `url` (the main one); `email` takes `to` (the main one), `subject`, `body`; `phone` takes `phone` (the main one); `whatsapp` takes `phone` (the main one), `message`; `app` takes `ios` (the main one), `android`, `fallback`; `crypto` takes `coin`, `address` (the main one), `amount`.\n\nThe answer's `link` is an empty string for a static code.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "data": {
                                        "type": "string",
                                        "description": "What the code holds. Send text to fill the main field of the type, such as the web address for `link`, or an object with the type's own fields."
                                    },
                                    "type": {
                                        "type": "string",
                                        "enum": [
                                            "text",
                                            "sms",
                                            "wifi",
                                            "vcard",
                                            "event",
                                            "link",
                                            "email",
                                            "phone",
                                            "whatsapp",
                                            "app",
                                            "crypto"
                                        ],
                                        "default": "link",
                                        "description": "What the code does when scanned. It cannot be changed afterwards."
                                    },
                                    "name": {
                                        "type": "string",
                                        "maxLength": 120,
                                        "description": "A name for you. It defaults to the start of the content."
                                    },
                                    "foreground": {
                                        "type": "string",
                                        "description": "The color of the code, such as `#17171a`. It must contrast enough with the background for a phone to read it."
                                    },
                                    "background": {
                                        "type": "string",
                                        "description": "The background color, such as `#ffffff`."
                                    },
                                    "logo": {
                                        "type": "string",
                                        "description": "A PNG, JPG or WebP picture of up to 500 KB, sent as base64 text or a data address, drawn in the middle of the code. Send an empty string to remove it."
                                    }
                                },
                                "required": [
                                    "data"
                                ],
                                "example": {
                                    "type": "link",
                                    "data": "https://example.com/menu",
                                    "name": "Table cards",
                                    "foreground": "#17171a"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "link": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 77,
                                        "link": "https://siz.la/menu-qr"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "The type or content is not valid, the colors are too close for a phone to read, the content is too long for one code, or the monthly limit is used up. `message` says which.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/qr/{id}/update": {
            "put": {
                "operationId": "updateQrCode",
                "tags": [
                    "QR codes"
                ],
                "summary": "Update a QR code",
                "description": "Change a QR code. Only the fields you send change. The type of a code cannot change. A dynamic code keeps its printed picture and sends scans to the new destination.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The code's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "data": {
                                        "type": "string",
                                        "description": "The new content: text for the main field of the type, or an object with the fields to change."
                                    },
                                    "name": {
                                        "type": "string",
                                        "maxLength": 120,
                                        "description": "A name for you. It defaults to the start of the content."
                                    },
                                    "foreground": {
                                        "type": "string",
                                        "description": "The color of the code, such as `#17171a`. It must contrast enough with the background for a phone to read it."
                                    },
                                    "background": {
                                        "type": "string",
                                        "description": "The background color, such as `#ffffff`."
                                    },
                                    "logo": {
                                        "type": "string",
                                        "description": "A PNG, JPG or WebP picture of up to 500 KB, sent as base64 text or a data address, drawn in the middle of the code. Send an empty string to remove it."
                                    }
                                },
                                "example": {
                                    "data": "https://example.com/new-menu"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "QR code has been updated successfully"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A value is not valid. `message` says which.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The code does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/qr/{id}/delete": {
            "delete": {
                "operationId": "deleteQrCode",
                "tags": [
                    "QR codes"
                ],
                "summary": "Delete a QR code",
                "description": "Delete a QR code. The short link made for a dynamic code goes with it, and printed copies stop working.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The code's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "QR code has been deleted successfully"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The code does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/overlay": {
            "get": {
                "operationId": "listOverlays",
                "tags": [
                    "Overlays"
                ],
                "summary": "List overlays",
                "description": "Your call-to-action messages by name. Send an id as `cta` when you make or change a link.\n\nOverlays are made and edited in the members area, under Call to action. `type` is one of `banner`, `card`, `button`. `error` is the text `\"0\"` on this endpoint and the number `0` on the others.",
                "parameters": [
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "How many overlays to return on a page.",
                        "schema": {
                            "type": "integer",
                            "default": 15,
                            "minimum": 1,
                            "maximum": 100
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to return.",
                        "schema": {
                            "type": "integer",
                            "default": 1,
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "string"
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "result": {
                                                    "type": "integer"
                                                },
                                                "perpage": {
                                                    "type": "integer"
                                                },
                                                "currentpage": {
                                                    "type": "integer"
                                                },
                                                "nextpage": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "maxpage": {
                                                    "type": "integer"
                                                },
                                                "cta": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "id": {
                                                                "type": "integer"
                                                            },
                                                            "type": {
                                                                "type": "string"
                                                            },
                                                            "name": {
                                                                "type": "string"
                                                            },
                                                            "date": {
                                                                "type": "string"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "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"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/channels": {
            "get": {
                "operationId": "listChannels",
                "tags": [
                    "Channels"
                ],
                "summary": "List channels",
                "description": "Your channels, starred ones first, then by name.\n\n`error` is the text `\"0\"` on this endpoint and the number `0` on the others.",
                "parameters": [
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "How many channels to return on a page.",
                        "schema": {
                            "type": "integer",
                            "default": 15,
                            "minimum": 1,
                            "maximum": 100
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to return.",
                        "schema": {
                            "type": "integer",
                            "default": 1,
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "string"
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "result": {
                                                    "type": "integer"
                                                },
                                                "perpage": {
                                                    "type": "integer"
                                                },
                                                "currentpage": {
                                                    "type": "integer"
                                                },
                                                "nextpage": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "maxpage": {
                                                    "type": "integer"
                                                },
                                                "channels": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "id": {
                                                                "type": "integer"
                                                            },
                                                            "name": {
                                                                "type": "string"
                                                            },
                                                            "description": {
                                                                "type": "string"
                                                            },
                                                            "color": {
                                                                "type": "string"
                                                            },
                                                            "starred": {
                                                                "type": "boolean"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": "0",
                                        "data": {
                                            "result": 1,
                                            "perpage": 10,
                                            "currentpage": 1,
                                            "nextpage": null,
                                            "maxpage": 1,
                                            "channels": [
                                                {
                                                    "id": 5,
                                                    "name": "Spring menu",
                                                    "description": "Everything for the spring menu launch",
                                                    "color": "ember",
                                                    "starred": true
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/channel/{id}": {
            "get": {
                "operationId": "listChannelItems",
                "tags": [
                    "Channels"
                ],
                "summary": "List what is in a channel",
                "description": "The links, QR codes and bio pages in one channel, newest first.\n\n`type` is `link`, `qr` or `bio`. `preview` is the destination of a link, the kind of a QR code, or the start of a bio page's text. `link` is the short address, empty for a static QR code.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The channel's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    },
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "How many items to return on a page.",
                        "schema": {
                            "type": "integer",
                            "default": 15,
                            "minimum": 1,
                            "maximum": 100
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to return.",
                        "schema": {
                            "type": "integer",
                            "default": 1,
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "string"
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "result": {
                                                    "type": "integer"
                                                },
                                                "perpage": {
                                                    "type": "integer"
                                                },
                                                "currentpage": {
                                                    "type": "integer"
                                                },
                                                "nextpage": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "maxpage": {
                                                    "type": "integer"
                                                },
                                                "items": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "type": {
                                                                "type": "string"
                                                            },
                                                            "id": {
                                                                "type": "integer"
                                                            },
                                                            "title": {
                                                                "type": "string"
                                                            },
                                                            "preview": {
                                                                "type": "string"
                                                            },
                                                            "link": {
                                                                "type": "string"
                                                            },
                                                            "date": {
                                                                "type": "string"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": "0",
                                        "data": {
                                            "result": 1,
                                            "perpage": 10,
                                            "currentpage": 1,
                                            "nextpage": null,
                                            "maxpage": 1,
                                            "items": [
                                                {
                                                    "type": "link",
                                                    "id": 1042,
                                                    "title": "lunch-menu",
                                                    "preview": "https://example.com/a/long/address",
                                                    "link": "https://siz.la/lunch-menu",
                                                    "date": "2026-11-14 09:30:00"
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The channel does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/channel/add": {
            "post": {
                "operationId": "createChannel",
                "tags": [
                    "Channels"
                ],
                "summary": "Make a channel",
                "description": "Make a channel. Put things in it with the `channel` option on a link or with the assign call.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "maxLength": 80,
                                        "description": "The channel's name. It must be different from your other channels."
                                    },
                                    "description": {
                                        "type": "string",
                                        "maxLength": 300,
                                        "description": "What the channel is for. Send an empty string to remove it."
                                    },
                                    "color": {
                                        "type": "string",
                                        "enum": [
                                            "ink",
                                            "ember",
                                            "sky",
                                            "mint",
                                            "lilac",
                                            "butter",
                                            "blush",
                                            "slate"
                                        ],
                                        "description": "The color of the channel's dot in the members area. The default is `ink`."
                                    },
                                    "starred": {
                                        "type": "boolean",
                                        "description": "Starred channels are listed first."
                                    }
                                },
                                "required": [
                                    "name"
                                ],
                                "example": {
                                    "name": "Spring menu",
                                    "description": "Everything for the spring menu launch",
                                    "starred": true
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "name": {
                                            "type": "string"
                                        },
                                        "description": {
                                            "type": "string"
                                        },
                                        "color": {
                                            "type": "string"
                                        },
                                        "starred": {
                                            "type": "boolean"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 5,
                                        "name": "Spring menu",
                                        "description": "Everything for the spring menu launch",
                                        "color": "ember",
                                        "starred": true
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "The name is missing or already used, a value is not allowed, or the account has the most channels it can keep.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/channel/{id}/update": {
            "put": {
                "operationId": "updateChannel",
                "tags": [
                    "Channels"
                ],
                "summary": "Update a channel",
                "description": "Change a channel. Only the fields you send change.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The channel's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "maxLength": 80,
                                        "description": "The channel's name. It must be different from your other channels."
                                    },
                                    "description": {
                                        "type": "string",
                                        "maxLength": 300,
                                        "description": "What the channel is for. Send an empty string to remove it."
                                    },
                                    "color": {
                                        "type": "string",
                                        "enum": [
                                            "ink",
                                            "ember",
                                            "sky",
                                            "mint",
                                            "lilac",
                                            "butter",
                                            "blush",
                                            "slate"
                                        ],
                                        "description": "The color of the channel's dot in the members area. The default is `ink`."
                                    },
                                    "starred": {
                                        "type": "boolean",
                                        "description": "Starred channels are listed first."
                                    }
                                },
                                "example": {
                                    "starred": false
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Channel has been updated successfully"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A value is not allowed. `message` says which.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The channel does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/channel/{id}/delete": {
            "delete": {
                "operationId": "deleteChannel",
                "tags": [
                    "Channels"
                ],
                "summary": "Delete a channel",
                "description": "Delete a channel. What was in it keeps working and leaves the channel.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The channel's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Channel has been deleted successfully"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The channel does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/channel/{id}/assign/{type}/{item}": {
            "post": {
                "operationId": "assignToChannel",
                "tags": [
                    "Channels"
                ],
                "summary": "Put something in a channel",
                "description": "Move one of your links, QR codes or bio pages into a channel. An item is in one channel at a time, so this takes it out of its old one.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The channel's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    },
                    {
                        "name": "type",
                        "in": "path",
                        "required": true,
                        "description": "What kind of item it is.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "link",
                                "qr",
                                "bio"
                            ]
                        }
                    },
                    {
                        "name": "item",
                        "in": "path",
                        "required": true,
                        "description": "The item's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Item has been assigned to the channel."
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "The type is not `link`, `qr` or `bio`.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The channel or the item does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/channel/{id}/unassign/{type}/{item}": {
            "delete": {
                "operationId": "unassignFromChannel",
                "tags": [
                    "Channels"
                ],
                "summary": "Take something out of a channel",
                "description": "Take an item out of a channel. The item itself is not touched.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The channel's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    },
                    {
                        "name": "type",
                        "in": "path",
                        "required": true,
                        "description": "What kind of item it is.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "link",
                                "qr",
                                "bio"
                            ]
                        }
                    },
                    {
                        "name": "item",
                        "in": "path",
                        "required": true,
                        "description": "The item's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Item has been taken out of the channel."
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "The type is not `link`, `qr` or `bio`.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The channel does not exist, or the item is not in it.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/splash": {
            "get": {
                "operationId": "listSplash",
                "tags": [
                    "Splash pages"
                ],
                "summary": "List splash pages",
                "description": "Your splash pages by name, with how many links use each.\n\n`error` is the text `\"0\"` on this endpoint and the number `0` on the others.",
                "parameters": [
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "How many splash pages to return on a page.",
                        "schema": {
                            "type": "integer",
                            "default": 15,
                            "minimum": 1,
                            "maximum": 100
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "required": false,
                        "description": "Which page to return.",
                        "schema": {
                            "type": "integer",
                            "default": 1,
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "string"
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "result": {
                                                    "type": "integer"
                                                },
                                                "perpage": {
                                                    "type": "integer"
                                                },
                                                "currentpage": {
                                                    "type": "integer"
                                                },
                                                "nextpage": {
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "maxpage": {
                                                    "type": "integer"
                                                },
                                                "splash": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "id": {
                                                                "type": "integer"
                                                            },
                                                            "name": {
                                                                "type": "string"
                                                            },
                                                            "date": {
                                                                "type": "string"
                                                            },
                                                            "title": {
                                                                "type": "string"
                                                            },
                                                            "message": {
                                                                "type": "string"
                                                            },
                                                            "button_label": {
                                                                "type": "string"
                                                            },
                                                            "seconds": {
                                                                "type": "integer"
                                                            },
                                                            "background_color": {
                                                                "type": "string"
                                                            },
                                                            "text_color": {
                                                                "type": "string"
                                                            },
                                                            "button_color": {
                                                                "type": "string"
                                                            },
                                                            "show_branding": {
                                                                "type": "boolean"
                                                            },
                                                            "links": {
                                                                "type": "integer"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "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
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/splash/add": {
            "post": {
                "operationId": "createSplash",
                "tags": [
                    "Splash pages"
                ],
                "summary": "Make a splash page",
                "description": "Make a splash page. Use it on a link with the `splash` option. A picture can be added in the members area.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "maxLength": 80,
                                        "description": "The splash page's name, for you. Visitors do not see it."
                                    },
                                    "title": {
                                        "type": "string",
                                        "maxLength": 120,
                                        "description": "The heading visitors see."
                                    },
                                    "message": {
                                        "type": "string",
                                        "maxLength": 500,
                                        "description": "A few lines under the title. Send an empty string to remove it."
                                    },
                                    "button_label": {
                                        "type": "string",
                                        "maxLength": 40,
                                        "description": "The words on the button, which skips the wait. The default is `Continue`."
                                    },
                                    "seconds": {
                                        "type": "integer",
                                        "default": 5,
                                        "minimum": 2,
                                        "maximum": 15,
                                        "description": "How long the page waits before it moves on by itself."
                                    },
                                    "background_color": {
                                        "type": "string",
                                        "description": "Page color as six-digit hex, such as `#ffffff`."
                                    },
                                    "text_color": {
                                        "type": "string",
                                        "description": "Text color as six-digit hex."
                                    },
                                    "button_color": {
                                        "type": "string",
                                        "description": "Button color as six-digit hex."
                                    },
                                    "show_branding": {
                                        "type": "boolean",
                                        "description": "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."
                                    }
                                },
                                "required": [
                                    "name",
                                    "title"
                                ],
                                "example": {
                                    "name": "Menu launch",
                                    "title": "Taking you to the new menu",
                                    "message": "Show this page at the counter for a free coffee.",
                                    "seconds": 5
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "name": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 7,
                                        "name": "Menu launch"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "The name or title is missing, a value is not allowed, or the account has the most splash pages its plan allows.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/splash/{id}/update": {
            "put": {
                "operationId": "updateSplash",
                "tags": [
                    "Splash pages"
                ],
                "summary": "Update a splash page",
                "description": "Change a splash page. Only the fields you send change, and every link that uses it shows the new page.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The splash page's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "name": {
                                        "type": "string",
                                        "maxLength": 80,
                                        "description": "The splash page's name, for you. Visitors do not see it."
                                    },
                                    "title": {
                                        "type": "string",
                                        "maxLength": 120,
                                        "description": "The heading visitors see."
                                    },
                                    "message": {
                                        "type": "string",
                                        "maxLength": 500,
                                        "description": "A few lines under the title. Send an empty string to remove it."
                                    },
                                    "button_label": {
                                        "type": "string",
                                        "maxLength": 40,
                                        "description": "The words on the button, which skips the wait. The default is `Continue`."
                                    },
                                    "seconds": {
                                        "type": "integer",
                                        "default": 5,
                                        "minimum": 2,
                                        "maximum": 15,
                                        "description": "How long the page waits before it moves on by itself."
                                    },
                                    "background_color": {
                                        "type": "string",
                                        "description": "Page color as six-digit hex, such as `#ffffff`."
                                    },
                                    "text_color": {
                                        "type": "string",
                                        "description": "Text color as six-digit hex."
                                    },
                                    "button_color": {
                                        "type": "string",
                                        "description": "Button color as six-digit hex."
                                    },
                                    "show_branding": {
                                        "type": "boolean",
                                        "description": "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": {
                                    "seconds": 8
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "name": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 7,
                                        "name": "Menu launch"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A value is not allowed. `message` says which.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The splash page does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/splash/{id}/delete": {
            "delete": {
                "operationId": "deleteSplash",
                "tags": [
                    "Splash pages"
                ],
                "summary": "Delete a splash page",
                "description": "Delete a splash page. Links that used it keep working and open without it.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The splash page's id.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Splash page has been deleted successfully"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The splash page does not exist or belongs to someone else.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/account": {
            "get": {
                "operationId": "getAccount",
                "tags": [
                    "Account"
                ],
                "summary": "Get the account",
                "description": "The account the key belongs to. A good first call to check that a key works.\n\n`status` is `free` on the free plan and `pro` on every paid plan.",
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "id": {
                                                    "type": "integer"
                                                },
                                                "email": {
                                                    "type": "string"
                                                },
                                                "username": {
                                                    "type": "string"
                                                },
                                                "avatar": {
                                                    "type": "string"
                                                },
                                                "status": {
                                                    "type": "string"
                                                },
                                                "expires": {
                                                    "type": "string"
                                                },
                                                "registered": {
                                                    "type": "string"
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "data": {
                                            "id": 7,
                                            "email": "you@example.com",
                                            "username": "you",
                                            "avatar": "https://www.gravatar.com/avatar/00000000000000000000000000000000?d=mp",
                                            "status": "pro",
                                            "expires": "",
                                            "registered": "2026-10-02 14:05:11"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/account/update": {
            "put": {
                "operationId": "updateAccount",
                "tags": [
                    "Account"
                ],
                "summary": "Update the account",
                "description": "Change the email address or the password. Changing either one also needs the current password, so a key alone cannot take an account over.",
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "email": {
                                        "type": "string",
                                        "description": "The new email address. A confirmation message is sent to it."
                                    },
                                    "password": {
                                        "type": "string",
                                        "minLength": 8,
                                        "description": "The new password, at least 8 characters."
                                    },
                                    "current_password": {
                                        "type": "string",
                                        "description": "The current password. Required when you change the email or the password."
                                    }
                                },
                                "example": {
                                    "email": "new@example.com",
                                    "current_password": "your-current-password"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Account has been successfully updated."
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "The email or password is not valid.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The current password is missing or wrong.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/clicks": {
            "get": {
                "operationId": "exportClicks",
                "tags": [
                    "Click export"
                ],
                "summary": "Export clicks",
                "description": "Stream the raw clicks on one link or on the whole account, as JSON lines or CSV. Only clicks your plan still keeps are included.\n\nEvery row has the same fields. `is_bot` clicks are included so you can filter them yourself; the totals in the app leave them out.\n\nNeeds Pro and the plans above it.",
                "parameters": [
                    {
                        "name": "format",
                        "in": "query",
                        "required": false,
                        "description": "JSON lines (one object a line) or CSV.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "jsonl",
                                "csv"
                            ],
                            "default": "jsonl"
                        }
                    },
                    {
                        "name": "link",
                        "in": "query",
                        "required": false,
                        "description": "Only the clicks on this link id. Leave it out for the whole account.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "from",
                        "in": "query",
                        "required": false,
                        "description": "The first day to include, as `YYYY-MM-DD`.",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "to",
                        "in": "query",
                        "required": false,
                        "description": "The last day to include, as `YYYY-MM-DD`.",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The rows, one object a line. Send `format=csv` for CSV with the same columns.",
                        "content": {
                            "application/x-ndjson": {
                                "schema": {
                                    "type": "string"
                                },
                                "example": "{\"id\":90211,\"clicked_at\":\"2026-11-14T09:41:07+00:00\",\"link_id\":1042,\"code\":\"lunch-menu\",\"country\":\"US\",\"city\":\"Austin\",\"language\":\"en\",\"referrer_host\":\"t.co\",\"referrer\":\"https://t.co/\",\"ai_assistant\":null,\"browser\":\"Chrome\",\"os\":\"iOS\",\"device\":\"mobile\",\"is_unique\":true,\"is_bot\":false,\"is_qr\":false,\"utm_source\":null,\"utm_medium\":null,\"utm_campaign\":null,\"click_id\":\"3f9a6c1e5b7d40a28c91e0d4\",\"visitor_hash\":\"a1b2c3d4\"}"
                            },
                            "text/csv": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "The format is not `csv` or `jsonl`.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The `link` is not one of yours.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/conversions": {
            "post": {
                "operationId": "createConversion",
                "tags": [
                    "Conversions"
                ],
                "summary": "Record a conversion",
                "description": "Tell siz.la that a click led to a sign-up or a sale. Call it from your server with your API key.\n\nA repeated `reference` answers 200 with `\"duplicate\": true` and the id of the first one.\n\nNeeds Pro and the plans above it.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "click_id": {
                                        "type": "string",
                                        "description": "The click id, 24 characters, from the `sz_cid` value on the address the visitor landed on."
                                    },
                                    "name": {
                                        "type": "string",
                                        "maxLength": 60,
                                        "description": "What happened, such as `signup` or `purchase`."
                                    },
                                    "value": {
                                        "type": "number",
                                        "minimum": 0,
                                        "description": "What it was worth, such as `49.00`."
                                    },
                                    "currency": {
                                        "type": "string",
                                        "description": "A three-letter currency code. Used when a value is sent; the default is `USD`."
                                    },
                                    "reference": {
                                        "type": "string",
                                        "maxLength": 100,
                                        "description": "Your own id for this event, such as an order number. Sending the same reference again for the same link does not count it twice."
                                    }
                                },
                                "required": [
                                    "click_id",
                                    "name"
                                ],
                                "example": {
                                    "click_id": "3f9a6c1e5b7d40a28c91e0d4",
                                    "name": "purchase",
                                    "value": 49,
                                    "currency": "USD",
                                    "reference": "order-1042"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "duplicate": {
                                            "type": "boolean"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 318,
                                        "duplicate": false
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include conversion tracking.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "No click of yours matches that id.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "A field is not valid, or the click is older than the counting window.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            },
            "get": {
                "operationId": "listConversions",
                "tags": [
                    "Conversions"
                ],
                "summary": "List conversions",
                "description": "Totals, the conversion rate and the newest conversions for one link or the whole account.\n\n`recent` holds the newest 100. `value` has one total for each currency.\n\nNeeds Pro and the plans above it.",
                "parameters": [
                    {
                        "name": "link",
                        "in": "query",
                        "required": false,
                        "description": "Only this link id. Leave it out for the whole account.",
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "days",
                        "in": "query",
                        "required": false,
                        "description": "How many days back to report.",
                        "schema": {
                            "type": "integer",
                            "default": 30,
                            "minimum": 1,
                            "maximum": 365
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "days": {
                                            "type": "integer"
                                        },
                                        "conversions": {
                                            "type": "integer"
                                        },
                                        "clicks": {
                                            "type": "integer"
                                        },
                                        "conversion_rate": {
                                            "type": "number"
                                        },
                                        "value": {
                                            "type": "object",
                                            "properties": {
                                                "USD": {
                                                    "type": "number"
                                                }
                                            }
                                        },
                                        "by_name": {
                                            "type": "object",
                                            "properties": {
                                                "purchase": {
                                                    "type": "integer"
                                                },
                                                "signup": {
                                                    "type": "integer"
                                                }
                                            }
                                        },
                                        "recent": {
                                            "type": "array",
                                            "items": {
                                                "type": "object",
                                                "properties": {
                                                    "id": {
                                                        "type": "integer"
                                                    },
                                                    "link_id": {
                                                        "type": "integer"
                                                    },
                                                    "click_id": {
                                                        "type": "string"
                                                    },
                                                    "name": {
                                                        "type": "string"
                                                    },
                                                    "value": {
                                                        "type": "number"
                                                    },
                                                    "currency": {
                                                        "type": "string"
                                                    },
                                                    "reference": {
                                                        "type": "string"
                                                    },
                                                    "source": {
                                                        "type": "string"
                                                    },
                                                    "converted_at": {
                                                        "type": "string"
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "days": 30,
                                        "conversions": 4,
                                        "clicks": 37,
                                        "conversion_rate": 10.800000000000000710542735760100185871124267578125,
                                        "value": {
                                            "USD": 196
                                        },
                                        "by_name": {
                                            "purchase": 3,
                                            "signup": 1
                                        },
                                        "recent": [
                                            {
                                                "id": 318,
                                                "link_id": 1042,
                                                "click_id": "3f9a6c1e5b7d40a28c91e0d4",
                                                "name": "purchase",
                                                "value": 49,
                                                "currency": "USD",
                                                "reference": "order-1042",
                                                "source": "server",
                                                "converted_at": "2026-11-14T10:02:44+00:00"
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include conversion tracking.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "The `link` is not one of yours.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/conversions/beacon": {
            "post": {
                "operationId": "beaconConversion",
                "tags": [
                    "Conversions"
                ],
                "summary": "Record a conversion from the browser",
                "description": "The call the browser snippet makes. There is no API key: the click id is the proof. It always answers 204 with no body, even when it refuses the report.\n\nMost people use the `sz.js` snippet instead of calling this directly. See the conversions page.\n\nAnyone who has a click id can report a conversion for it. Use the server call for anything you pay out on.\n\nNeeds Pro and the plans above it.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "click_id": {
                                        "type": "string",
                                        "description": "The click id."
                                    },
                                    "name": {
                                        "type": "string",
                                        "description": "What happened."
                                    },
                                    "value": {
                                        "type": "number",
                                        "description": "What it was worth."
                                    },
                                    "currency": {
                                        "type": "string",
                                        "description": "A three-letter currency code."
                                    },
                                    "reference": {
                                        "type": "string",
                                        "description": "Your own id for this event."
                                    }
                                },
                                "required": [
                                    "click_id",
                                    "name"
                                ],
                                "example": {
                                    "click_id": "3f9a6c1e5b7d40a28c91e0d4",
                                    "name": "signup"
                                }
                            }
                        }
                    }
                },
                "security": [],
                "responses": {
                    "204": {
                        "description": "Accepted. There is no body."
                    }
                }
            }
        },
        "/hooks/events": {
            "get": {
                "operationId": "listHookEvents",
                "tags": [
                    "Hook subscriptions"
                ],
                "summary": "List the events",
                "description": "Every event a subscription can ask for, and the trigger name the Zapier app gives it.\n\nThe real answer lists every event. The `trigger` is `null` for an event the Zapier app has no trigger for.",
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "events": {
                                            "type": "array",
                                            "items": {
                                                "type": "object",
                                                "properties": {
                                                    "event": {
                                                        "type": "string"
                                                    },
                                                    "description": {
                                                        "type": "string"
                                                    },
                                                    "trigger": {
                                                        "type": "string"
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "events": [
                                            {
                                                "event": "bio.signup",
                                                "description": "Someone signs up for email on a bio page",
                                                "trigger": "New email sign-up"
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/hooks": {
            "get": {
                "operationId": "listHooks",
                "tags": [
                    "Hook subscriptions"
                ],
                "summary": "List subscriptions",
                "description": "The subscriptions other tools made with your key. Addresses you added yourself on the Webhooks page are not listed here.",
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "hooks": {
                                            "type": "array",
                                            "items": {
                                                "type": "object",
                                                "properties": {
                                                    "id": {
                                                        "type": "integer"
                                                    },
                                                    "event": {
                                                        "type": "string"
                                                    },
                                                    "target_url": {
                                                        "type": "string"
                                                    },
                                                    "source": {
                                                        "type": "string"
                                                    },
                                                    "is_active": {
                                                        "type": "boolean"
                                                    },
                                                    "created_at": {
                                                        "type": "string"
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "hooks": [
                                            {
                                                "id": 14,
                                                "event": "bio.signup",
                                                "target_url": "https://hooks.zapier.com/hooks/standard/1/abc",
                                                "source": "zapier",
                                                "is_active": true,
                                                "created_at": "2026-11-14T09:30:00+00:00"
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            },
            "post": {
                "operationId": "subscribeHook",
                "tags": [
                    "Hook subscriptions"
                ],
                "summary": "Subscribe to an event",
                "description": "Ask for a message at `target_url` each time the event happens. The message is the same signed webhook message described on the webhooks page.\n\n`secret` is shown once, in this answer. Use it to check the signature on each message, or ignore it if the tool does not check.\n\nSubscribing the same address to the same event again answers `200` with the subscription that exists and a `secret` of `null`.\n\nClicks and scans from now on are sent. Nothing from before the subscription is sent.\n\nWhen the address answers `410` to a message, the subscription is removed.\n\nNeeds Pro and the plans above it.",
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "event": {
                                        "type": "string",
                                        "enum": [
                                            "link.created",
                                            "link.updated",
                                            "link.clicked",
                                            "conversion.created",
                                            "bio.signup",
                                            "qr.scanned"
                                        ],
                                        "description": "The event to subscribe to."
                                    },
                                    "target_url": {
                                        "type": "string",
                                        "maxLength": 500,
                                        "description": "The address that receives the messages. It must start with `https://` and be on the public internet."
                                    },
                                    "source": {
                                        "type": "string",
                                        "enum": [
                                            "zapier",
                                            "make",
                                            "n8n",
                                            "api"
                                        ],
                                        "description": "Which tool is subscribing. Anything else is saved as `api`."
                                    },
                                    "label": {
                                        "type": "string",
                                        "maxLength": 120,
                                        "description": "A name to show next to the subscription in the members area."
                                    }
                                },
                                "required": [
                                    "event",
                                    "target_url"
                                ],
                                "example": {
                                    "event": "bio.signup",
                                    "target_url": "https://hooks.zapier.com/hooks/standard/1/abc",
                                    "source": "zapier"
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "id": {
                                            "type": "integer"
                                        },
                                        "event": {
                                            "type": "string"
                                        },
                                        "target_url": {
                                            "type": "string"
                                        },
                                        "source": {
                                            "type": "string"
                                        },
                                        "is_active": {
                                            "type": "boolean"
                                        },
                                        "created_at": {
                                            "type": "string"
                                        },
                                        "secret": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "id": 14,
                                        "event": "bio.signup",
                                        "target_url": "https://hooks.zapier.com/hooks/standard/1/abc",
                                        "source": "zapier",
                                        "is_active": true,
                                        "created_at": "2026-11-14T09:30:00+00:00",
                                        "secret": "whsec_0f1e2d3c4b5a69788796a5b4c3d2e1f001122334"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "403": {
                        "description": "The plan does not include webhooks.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "422": {
                        "description": "The event or address is not valid, or the account holds the most subscriptions it can.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/hooks/{id}": {
            "delete": {
                "operationId": "unsubscribeHook",
                "tags": [
                    "Hook subscriptions"
                ],
                "summary": "Remove a subscription",
                "description": "Stop the messages for one subscription.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "description": "The subscription id from the subscribe answer.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "message": {
                                            "type": "string"
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "message": "Hook subscription has been deleted successfully"
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The subscription does not exist, or it is not yours.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        },
        "/hooks/sample/{event}": {
            "get": {
                "operationId": "sampleHook",
                "tags": [
                    "Hook subscriptions"
                ],
                "summary": "Sample data for an event",
                "description": "A worked example of what an event sends, for a tool that shows sample data while a person sets up a step.\n\n`items` is what a trigger hands on, one entry for each thing that happened. Each has an `id`. `message` is the whole message as it is sent.",
                "parameters": [
                    {
                        "name": "event",
                        "in": "path",
                        "required": true,
                        "description": "The event name.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "link.created",
                                "link.updated",
                                "link.clicked",
                                "conversion.created",
                                "bio.signup",
                                "qr.scanned"
                            ]
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "error": {
                                            "type": "integer"
                                        },
                                        "event": {
                                            "type": "string"
                                        },
                                        "items": {
                                            "type": "array",
                                            "items": {
                                                "type": "object",
                                                "properties": {
                                                    "id": {
                                                        "type": "integer"
                                                    },
                                                    "email": {
                                                        "type": "string"
                                                    },
                                                    "name": {
                                                        "type": "string"
                                                    },
                                                    "page_id": {
                                                        "type": "integer"
                                                    },
                                                    "page_name": {
                                                        "type": "string"
                                                    },
                                                    "page_url": {
                                                        "type": "string"
                                                    },
                                                    "block_id": {
                                                        "type": "string"
                                                    },
                                                    "signed_up_at": {
                                                        "type": "string"
                                                    }
                                                }
                                            }
                                        },
                                        "message": {
                                            "type": "object",
                                            "properties": {
                                                "id": {
                                                    "type": "string"
                                                },
                                                "event": {
                                                    "type": "string"
                                                },
                                                "created_at": {
                                                    "type": "string"
                                                },
                                                "data": {
                                                    "type": "object",
                                                    "properties": {
                                                        "signup": {
                                                            "type": "object",
                                                            "properties": {
                                                                "id": {
                                                                    "type": "integer"
                                                                },
                                                                "email": {
                                                                    "type": "string"
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "example": {
                                        "error": 0,
                                        "event": "bio.signup",
                                        "items": [
                                            {
                                                "id": 77,
                                                "email": "sam@example.com",
                                                "name": "Sam",
                                                "page_id": 9,
                                                "page_name": "Lunch menu",
                                                "page_url": "https://siz.la/lunch-menu",
                                                "block_id": "k3d9x2",
                                                "signed_up_at": "2026-11-14T09:52:10+00:00"
                                            }
                                        ],
                                        "message": {
                                            "id": "6f1d2c1e-8a47-4c35-9d0b-2a1c0f5e7b90",
                                            "event": "bio.signup",
                                            "created_at": "2026-11-14T10:02:44+00:00",
                                            "data": {
                                                "signup": {
                                                    "id": 77,
                                                    "email": "sam@example.com"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "description": "The event does not exist.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    },
                    "429": {
                        "$ref": "#/components/responses/RateLimited"
                    }
                }
            }
        }
    },
    "components": {
        "securitySchemes": {
            "bearerAuth": {
                "type": "http",
                "scheme": "bearer",
                "description": "An API key from Settings, then Developers. Send it as `Authorization: Bearer YOUR_KEY`."
            }
        },
        "schemas": {
            "Error": {
                "type": "object",
                "required": [
                    "error",
                    "message"
                ],
                "properties": {
                    "error": {
                        "type": "integer",
                        "const": 1
                    },
                    "message": {
                        "type": "string",
                        "description": "What went wrong, in plain words."
                    }
                },
                "example": {
                    "error": 1,
                    "message": "A valid API key is required."
                }
            }
        },
        "responses": {
            "Unauthorized": {
                "description": "A valid API key is required.",
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/Error"
                        }
                    }
                }
            },
            "RateLimited": {
                "description": "Too many requests. The Retry-After header says how many seconds to wait.",
                "headers": {
                    "Retry-After": {
                        "description": "Seconds to wait.",
                        "schema": {
                            "type": "integer"
                        }
                    }
                },
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/Error"
                        }
                    }
                }
            }
        }
    }
}
