Quicklinks

Quicklinks are URLs to commonly used websites to be opened inside Ziik.

curl "https://example.ziik.io/api/quicklinks"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
[{
    "id": 4,
    "content_type": "quick_links",
    "permissions": {
        "edit": true,
        "delete": true
    },
    "name": "Site One",
    "link": "https://example.com/full/path",
    "url": "api/quicklinks/4"
}, {
    "id": 6,
    "content_type": "quick_links",
    "permissions": {
        "edit": true,
        "delete": true
    },
    "name": "Business News",
    "link": "https://newssite.com",
    "url": "api/quicklinks/6"
}, {
    "id": 7,
    "content_type": "quick_links",
    "permissions": {
        "edit": true,
        "delete": true
    },
    "name": "Website",
    "link": "http://website.com",
    "url": "api/quicklinks/7"
}]

This endpoint retrieves all quicklinks

HTTP Request

GET https://example.ziik.io/api/quicklinks

Query Parameters

None - all quicklinks are returned

curl "https://example.ziik.io/api/quicklinks/4"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"

The above command returns JSON structured like this:

  {
      "id": 4,
      "content_type": "quick_links",
      "permissions": {
          "edit": true,
          "delete": true
      },
      "name": "Site One",
      "link": "https://example.com/full/path",
      "url": "api/quicklinks/4"
  }

This endpoint returns a single quicklink

HTTP Request

GET https://example.ziik.io/api/quicklinks/ID

URL Parameters

ParameterTypeDescription
IDIntegerThe ID of the quicklink
curl -i -X POST "https://example.ziik.io/api/quicklinks"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 201 Created with a location header for where to find the newly created quicklink

HTTP/1.0 201 Created
Location: https://example.ziik.io/api/quicklinks/1234
{
    "message": "Quicklink created"
}

This endpoint creates a quicklink.

HTTP Request

POST https://example.ziik.io/api/quicklinks

Request Parameters

ParameterTypeRequiredDescription
nameStringYesName of quicklink.
linkStringYesFull URL to the destination including protocol

Permissions Required

  • Administer permission to quicklinks
curl -i -X PATCH "https://example.ziik.io/api/quicklinks/123"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 204 No Content on successful update.

HTTP/1.0 204 No Content

This endpoint updates an existing quicklink.

HTTP Request

PATCH https://example.ziik.io/api/quicklinks/ID

Request Parameters

ParameterTypeRequiredDescription
nameStringNoName of quicklink.
linkStringNoFull URL to the destination including protocol

Permissions Required

  • Administer permission to quicklinks
curl -i -X DELETE "https://example.ziik.io/api/quicklinks/123"
  -H "Authorization: Bearer aaaaaa.bbbbbbb.ccccccc"

The above command returns a 204 No Content header on success:

HTTP/1.0 204 No Content

This endpoint deletes a quicklink.

HTTP Request

DELETE https://example.ziik.io/api/quicklinks/ID

URL Parameters

ParameterTypeDescription
IDIntegerThe ID of the quicklink to delete

Permissions Required

  • Administer permission to quicklinks