v1
latestOpenAPI 3.0.32026-07-1419076.2 KBGet Links
This endpoint retrieves all links available to the client.
get/links
Query parameters
domain_idinteger required
The Domain ID used to retrieve links.
pageinteger
The current page of results to retrieve.
per_pageinteger
The number of results to pull back. Allowed values: 25, 50, 100, -1 (for all).
sortstring
The order for record sorting. Allowed values are asc and desc.
orderstring
The field for sorting records. Allowed values: id, name, scope, type, length, status.
Response
200
Example response
{
"data": [
{
"id": 1,
"name": "Test Link",
"path": "testing",
"redirect": "https://seebot.run",
"status": "active",
"health_status": "unknown",
"domain_id": 1000,
"generated_url": "http://seebot.test/testing",
"domain": {
"id": 1000,
"name": "seebot.test",
"url": "seebot.test",
"status": "active",
"scope": "client"
},
"tags": [
{
"id": 1,
"name": "Important",
"color": "#C0382B",
"status": "active"
}
]
}
],
"meta": {
"total": 1,
"count": 1,
"page": 1,
"pages": 1,
"per_page": 25,
"order": "id",
"sort": "DESC"
}
}