Tags

Tag model

Tag

A tag is just a string that can be added as a label to a bookmark

Get list of tags

GET /public/rest/v2/tag

Synopsis:

Retrieve a list of tags

Added in version 0.11.0.

Example:

GET /index.php/apps/bookmarks/public/rest/v2/tag HTTP/1.1
Host: example.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Content-Type: application/json

["politics", "satire", "tech", "music", "art", "blogs", "personal"]

Delete a tag

DELETE /public/rest/v2/tag/(string: tag)

Synopsis:

Delete a tag

Added in version 0.11.0.

Response JSON Object:

• status (string) – success or error

Example:

DELETE /index.php/apps/bookmarks/public/rest/v2/tag/politics HTTP/1.1
Host: example.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{ "status": "success" }

Rename a tag

PUT /public/rest/v2/tag/(string: tag)

Synopsis:

Rename a tag

Added in version 0.11.0.

Request JSON Object:

• name (string) – The new name for the tag

Response JSON Object:

• status (string) – success or error

Example:

PUT /index.php/apps/bookmarks/public/rest/v2/tag/politics HTTP/1.1
Host: example.com
Accept: application/json

{ "name": "satire" }

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{ "status": "success" }