Skip to Content
Api ReferenceLinks Api

Last Updated: 3/16/2026

Links API

The Links API allows you to manage bookmarks in LinkAce programmatically.

Endpoints

GET /api/v2/links

Retrieve a paginated list of links visible to the authenticated user.

Query Parameters:

  • order_by - Field to order by: id, url, title, description, visibility, status, check_disabled, created_at, updated_at, random
  • order_dir - Sort direction: asc or desc (default: desc)
  • page - Page number
  • per_page - Items per page

Response:

{
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "url": "https://example.com",
      "title": "Example Site",
      "description": "An example bookmark",
      "icon": "bookmark",
      "visibility": 1,
      "status": 1,
      "check_disabled": false,
      "created_at": "2024-01-15T10:30:00.000000Z",
      "updated_at": "2024-01-15T10:30:00.000000Z"
    }
  ],
  "links": { ... },
  "meta": { ... }
}
GET /api/v2/links/{id}

Retrieve a specific link by ID, including related lists and tags.

Response:

{
  "id": 1,
  "user_id": 1,
  "url": "https://example.com",
  "title": "Example Site",
  "description": "An example bookmark",
  "icon": "bookmark",
  "visibility": 1,
  "status": 1,
  "check_disabled": false,
  "created_at": "2024-01-15T10:30:00.000000Z",
  "updated_at": "2024-01-15T10:30:00.000000Z",
  "lists": [...],
  "tags": [...]
}
POST /api/v2/links

Create a new link.

Request Body:

{
  "url": "https://example.com",
  "title": "Example Site",
  "description": "An example bookmark",
  "visibility": 1,
  "lists": [1, 2],
  "tags": [3, 4]
}

Required Fields:

  • url - The URL to bookmark

Optional Fields:

  • title - Link title (auto-generated if not provided)
  • description - Link description (auto-generated if not provided)
  • icon - Icon identifier
  • visibility - Visibility level (1 = private, 2 = internal, 3 = public)
  • check_disabled - Disable automatic link checking (boolean)
  • lists - Array of list IDs to associate
  • tags - Array of tag IDs to associate

Response: Returns the created link object.

PATCH /api/v2/links/{id}

Update an existing link.

Request Body: Same as Create Link, all fields optional.

Response: Returns the updated link object.

DELETE /api/v2/links/{id}

Delete a link (moves to trash).

Response: Empty response with 200 status on success, 500 on failure.

GET /api/v2/links/check

Check the status of links (used for link health monitoring).

GET /api/v2/links/{id}/notes

Retrieve all notes associated with a specific link.

Response:

{
  "data": [
    {
      "id": 1,
      "link_id": 1,
      "note": "This is a note about the link",
      "created_at": "2024-01-15T10:30:00.000000Z",
      "updated_at": "2024-01-15T10:30:00.000000Z"
    }
  ]
}

Fields

  • id (integer) - Unique identifier
  • user_id (integer) - Owner user ID
  • url (string) - The bookmark URL
  • title (string) - Link title
  • description (string|null) - Link description
  • icon (string|null) - Icon identifier
  • visibility (integer) - Visibility level (1=private, 2=internal, 3=public)
  • status (integer) - Link status (1=OK, 2=Moved, 3=Broken)
  • check_disabled (boolean) - Whether automatic checking is disabled
  • last_checked_at (datetime|null) - Last check timestamp
  • thumbnail (string|null) - Thumbnail URL
  • created_at (datetime) - Creation timestamp
  • updated_at (datetime) - Last update timestamp
  • deleted_at (datetime|null) - Soft delete timestamp

Visibility Levels

  • 1 - Private: Only visible to the owner
  • 2 - Internal: Visible to all authenticated users
  • 3 - Public: Visible to everyone

Status Codes

  • 1 - OK: Link is accessible
  • 2 - Moved: Link has been redirected
  • 3 - Broken: Link is inaccessible

Relationships

Links can be associated with:

  • Lists - Organize links into collections
  • Tags - Categorize links with tags
  • Notes - Add notes to links
  • User - Owner of the link

Authorization

All link operations require authentication. Users can only access:

  • Their own private links
  • Internal links from other users (if authenticated)
  • Public links from any user

System API tokens with private access can view all private content.

Next Steps

Api OverviewV2