Endpoints

Links

Operations around Links management.

Endpoints

GET /api/links
POST /api/links
GET /api/links/:linkId
POST /api/links/:linkId
DELETE /api/links/:linkId

GET /api/links#

Returns all user links.

Parameters

Parameter	Type	Description
`search`	string	(optional) Search text.
`page`	number	(optional, default 1) Determines page.
`pageSize`	number	(optional) Determines how many results to return.

Sample response

{
  "data": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "umami",
      "url": "https://www.umami.is",
      "slug": "xxxxxxxx",
      "userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "teamId": null,
      "createdAt": "2025-10-27T18:49:39.383Z",
      "updatedAt": "2025-10-27T18:49:39.383Z",
      "deletedAt": null
    }
  ],
  "count": 1,
  "page": 1,
  "pageSize": 20
}

POST /api/links#

Creates a link.

Parameters

Parameter	Type	Description
`name`	string	The link's name.
`url`	string	The link's destination URL.
`slug`	string	The link's URL slug (minimum 8 characters).
`teamId`	string	(optional) The ID of the team the link will be created under.

Request body

{
  "name": "umami",
  "url": "https://www.umami.is",
  "slug": "umami123"
}

Sample response

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "umami",
  "url": "https://www.umami.is",
  "slug": "umami123",
  "userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "teamId": null,
  "createdAt": "2025-10-27T18:49:39.383Z",
  "updatedAt": "2025-10-27T18:49:39.383Z",
  "deletedAt": null
}

GET /api/links/:linkId#

Gets a link by ID.

Sample response

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "umami",
  "url": "https://www.umami.is",
  "slug": "xxxxxxxx",
  "userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "teamId": null,
  "createdAt": "2025-10-27T18:49:39.383Z",
  "updatedAt": "2025-10-27T18:49:39.383Z",
  "deletedAt": null
}

POST /api/links/:linkId#

Updates a link.

Parameters

Parameter	Type	Description
`name`	string	(optional) The link's name.
`url`	string	(optional) The link's destination URL.
`slug`	string	(optional) The link's URL slug (minimum 8 characters).

Request body

{
  "name": "umami",
  "url": "https://www.umami.is"
}

Sample response

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "umami",
  "url": "https://www.umami.is",
  "slug": "xxxxxxxx",
  "userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "teamId": null,
  "createdAt": "2025-10-27T18:49:39.383Z",
  "updatedAt": "2025-10-30T23:06:01.824Z",
  "deletedAt": null
}

DELETE /api/links/:linkId#

Deletes a link.

Sample response

{
  "ok": true
}

PreviousEvents NextMe