Documentation
JSON Formats for Lists
Example 1: Basic JSON
This is the simplest format. A list of direct links without any nested structure.
[
{
"name": "Cats playing with yarn",
"url": "https://example.com/videos/cats-yarn"
},
{
"name": "Cats sleeping in strange positions",
"url": "https://example.com/videos/cats-sleeping"
},
{
"name": "Cats making biscuits",
"url": "https://example.com/videos/cats-biscuits"
}
]Example 2: JSON with Embedded Sublinks
This format includes sublinks directly in the JSON. Useful when you want to group related links.
[
{
"name": "Cats playing",
"url": "https://example.com/videos/cats-playing-main",
"subLinks": [
{
"name": "With feather toys",
"url": "https://example.com/videos/cats-feathers"
},
{
"name": "With cardboard boxes",
"url": "https://example.com/videos/cats-boxes"
}
]
},
{
"name": "Cats singing",
"url": "https://example.com/videos/meow-concert"
}
]Example 3: JSON with External References
This format includes references to other lists. Useful when you have many links and need to split them.
[
{
"name": "Baby cats",
"type": "category",
"ref": "kittens123" // This code points to another list
},
{
"name": "Adult cats",
"url": "https://example.com/videos/adult-cats"
},
{
"name": "Cat breeds",
"type": "category",
"ref": "breeds456" // This code points to another list
}
]Example 4: Mixed JSON (Sublinks and References)
This format combines all features. Maximum flexibility for organizing your links.
[
{
"name": "Famous cats",
"subLinks": [
{
"name": "Grumpy Cat",
"url": "https://example.com/videos/grumpy-cat"
},
{
"name": "Lil Bub",
"url": "https://example.com/videos/lil-bub"
}
]
},
{
"name": "More cat breeds",
"type": "category",
"ref": "more-breeds789"
}
]Important Notes on JSON Usage
- Structure: The JSON must always be an array ([]) of objects ()
- Required fields:
- "name": Always required
- "url" or "ref": At least one must exist
- Optional fields:
- "type": Only needed for references (value: "category")
- "subLinks": Array of nested items