Docs menu

Channels API

Make, list, change and delete channels, and put links, QR codes and bio pages in them, with the siz.la REST API.

A channel keeps links, QR codes and bio pages together, so you can find and manage a set of them in one place. Channels only group: they add no tracking values and do not combine clicks. For that, use (https://siz.la/docs/campaigns).

An item is in one channel at a time. Put a link in a channel with the channel option when you make or change it (see (https://siz.la/docs/links)), or move any link, QR code or bio page with the assign call. Deleting a channel leaves everything in it working. Reading needs a key. Making, changing, deleting and filling a channel need a key with write access.

List channels

GET/api/channels

Your channels, starred ones first, then by name.

Needs: API key.

Parameters

NameInTypeDescription
limitQueryintegerHow many channels to return on a page. 1 to 100. Default 15.
pageQueryintegerWhich page to return. At least 1. Default 1.

Example request

Shell
curl "https://siz.la/api/channels?limit=10&page=1" \
  -H "Authorization: Bearer $SIZLA_API_KEY"
JavaScript
const response = await fetch("https://siz.la/api/channels?limit=10&page=1", {
  headers: {
    Authorization: `Bearer ${process.env.SIZLA_API_KEY}`,
  },
});
const data = await response.json();
console.log(data);
Python
import os
import requests

response = requests.get(
    "https://siz.la/api/channels",
    headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
    params={
        "limit": 10,
        "page": 1,
    },
)
print(response.json())
PHP
$ch = curl_init('https://siz.la/api/channels?limit=10&page=1');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('SIZLA_API_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);

Example answer, status 200

JSON
{
    "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
            }
        ]
    }
}

Notes

  • error is the text "0" on this endpoint and the number 0 on the others.

List what is in a channel

GET/api/channel/{id}

The links, QR codes and bio pages in one channel, newest first.

Needs: API key.

Parameters

NameInTypeDescription
id (required)PathintegerThe channel's id. At least 1.
limitQueryintegerHow many items to return on a page. 1 to 100. Default 15.
pageQueryintegerWhich page to return. At least 1. Default 1.

Example request

Shell
curl "https://siz.la/api/channel/5?limit=10&page=1" \
  -H "Authorization: Bearer $SIZLA_API_KEY"
JavaScript
const response = await fetch("https://siz.la/api/channel/5?limit=10&page=1", {
  headers: {
    Authorization: `Bearer ${process.env.SIZLA_API_KEY}`,
  },
});
const data = await response.json();
console.log(data);
Python
import os
import requests

response = requests.get(
    "https://siz.la/api/channel/5",
    headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
    params={
        "limit": 10,
        "page": 1,
    },
)
print(response.json())
PHP
$ch = curl_init('https://siz.la/api/channel/5?limit=10&page=1');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('SIZLA_API_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);

Example answer, status 200

JSON
{
    "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"
            }
        ]
    }
}

Errors specific to this call

  • 404: The channel does not exist or belongs to someone else.

Notes

  • 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.

Make a channel

POST/api/channel/add

Make a channel. Put things in it with the channel option on a link or with the assign call.

Needs: API key with write access.

Parameters

NameInTypeDescription
name (required)BodystringThe channel's name. It must be different from your other channels. Up to 80 characters.
descriptionBodystringWhat the channel is for. Send an empty string to remove it. Up to 300 characters.
colorBodystringThe color of the channel's dot in the members area. The default is ink. One of ink, ember, sky, mint, lilac, butter, blush, slate.
starredBodybooleanStarred channels are listed first.

Example request

Shell
curl -X POST "https://siz.la/api/channel/add" \
  -H "Authorization: Bearer $SIZLA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Spring menu","description":"Everything for the spring menu launch","starred":true}'
JavaScript
const response = await fetch("https://siz.la/api/channel/add", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SIZLA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Spring menu",
    "description": "Everything for the spring menu launch",
    "starred": true
  }),
});
const data = await response.json();
console.log(data);
Python
import os
import requests

response = requests.post(
    "https://siz.la/api/channel/add",
    headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
    json={
        "name": "Spring menu",
        "description": "Everything for the spring menu launch",
        "starred": True,
    },
)
print(response.json())
PHP
$ch = curl_init('https://siz.la/api/channel/add');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('SIZLA_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'name' => 'Spring menu',
        'description' => 'Everything for the spring menu launch',
        'starred' => true,
    ]),
]);
$data = json_decode(curl_exec($ch), true);

Example answer, status 200

JSON
{
    "error": 0,
    "id": 5,
    "name": "Spring menu",
    "description": "Everything for the spring menu launch",
    "color": "ember",
    "starred": true
}

Errors specific to this call

  • 400: The name is missing or already used, a value is not allowed, or the account has the most channels it can keep.

Update a channel

PUT/api/channel/{id}/update

Change a channel. Only the fields you send change.

Needs: API key with write access.

Parameters

NameInTypeDescription
id (required)PathintegerThe channel's id. At least 1.
nameBodystringThe channel's name. It must be different from your other channels. Up to 80 characters.
descriptionBodystringWhat the channel is for. Send an empty string to remove it. Up to 300 characters.
colorBodystringThe color of the channel's dot in the members area. The default is ink. One of ink, ember, sky, mint, lilac, butter, blush, slate.
starredBodybooleanStarred channels are listed first.

Example request

Shell
curl -X PUT "https://siz.la/api/channel/5/update" \
  -H "Authorization: Bearer $SIZLA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"starred":false}'
JavaScript
const response = await fetch("https://siz.la/api/channel/5/update", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.SIZLA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "starred": false
  }),
});
const data = await response.json();
console.log(data);
Python
import os
import requests

response = requests.put(
    "https://siz.la/api/channel/5/update",
    headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
    json={
        "starred": False,
    },
)
print(response.json())
PHP
$ch = curl_init('https://siz.la/api/channel/5/update');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('SIZLA_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'starred' => false,
    ]),
]);
$data = json_decode(curl_exec($ch), true);

Example answer, status 200

JSON
{
    "error": 0,
    "message": "Channel has been updated successfully"
}

Errors specific to this call

  • 400: A value is not allowed. message says which.
  • 404: The channel does not exist or belongs to someone else.

Delete a channel

DELETE/api/channel/{id}/delete

Delete a channel. What was in it keeps working and leaves the channel.

Needs: API key with write access.

Parameters

NameInTypeDescription
id (required)PathintegerThe channel's id. At least 1.

Example request

Shell
curl -X DELETE "https://siz.la/api/channel/5/delete" \
  -H "Authorization: Bearer $SIZLA_API_KEY"
JavaScript
const response = await fetch("https://siz.la/api/channel/5/delete", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.SIZLA_API_KEY}`,
  },
});
const data = await response.json();
console.log(data);
Python
import os
import requests

response = requests.delete(
    "https://siz.la/api/channel/5/delete",
    headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
)
print(response.json())
PHP
$ch = curl_init('https://siz.la/api/channel/5/delete');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('SIZLA_API_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);

Example answer, status 200

JSON
{
    "error": 0,
    "message": "Channel has been deleted successfully"
}

Errors specific to this call

  • 404: The channel does not exist or belongs to someone else.

Put something in a channel

POST/api/channel/{id}/assign/{type}/{item}

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.

Needs: API key with write access.

Parameters

NameInTypeDescription
id (required)PathintegerThe channel's id. At least 1.
type (required)PathstringWhat kind of item it is. One of link, qr, bio.
item (required)PathintegerThe item's id. At least 1.

Example request

Shell
curl -X POST "https://siz.la/api/channel/5/assign/link/1042" \
  -H "Authorization: Bearer $SIZLA_API_KEY"
JavaScript
const response = await fetch("https://siz.la/api/channel/5/assign/link/1042", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SIZLA_API_KEY}`,
  },
});
const data = await response.json();
console.log(data);
Python
import os
import requests

response = requests.post(
    "https://siz.la/api/channel/5/assign/link/1042",
    headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
)
print(response.json())
PHP
$ch = curl_init('https://siz.la/api/channel/5/assign/link/1042');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('SIZLA_API_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);

Example answer, status 200

JSON
{
    "error": 0,
    "message": "Item has been assigned to the channel."
}

Errors specific to this call

  • 400: The type is not link, qr or bio.
  • 404: The channel or the item does not exist or belongs to someone else.

Take something out of a channel

DELETE/api/channel/{id}/unassign/{type}/{item}

Take an item out of a channel. The item itself is not touched.

Needs: API key with write access.

Parameters

NameInTypeDescription
id (required)PathintegerThe channel's id. At least 1.
type (required)PathstringWhat kind of item it is. One of link, qr, bio.
item (required)PathintegerThe item's id. At least 1.

Example request

Shell
curl -X DELETE "https://siz.la/api/channel/5/unassign/link/1042" \
  -H "Authorization: Bearer $SIZLA_API_KEY"
JavaScript
const response = await fetch("https://siz.la/api/channel/5/unassign/link/1042", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.SIZLA_API_KEY}`,
  },
});
const data = await response.json();
console.log(data);
Python
import os
import requests

response = requests.delete(
    "https://siz.la/api/channel/5/unassign/link/1042",
    headers={"Authorization": f"Bearer {os.environ['SIZLA_API_KEY']}"},
)
print(response.json())
PHP
$ch = curl_init('https://siz.la/api/channel/5/unassign/link/1042');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('SIZLA_API_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);

Example answer, status 200

JSON
{
    "error": 0,
    "message": "Item has been taken out of the channel."
}

Errors specific to this call

  • 400: The type is not link, qr or bio.
  • 404: The channel does not exist, or the item is not in it.