List Quicklinks

Returns all quicklinks for the given search engine.

GET /api/engine/{engineId}/quicklinks

List Quicklinks

cURL

curl --request GET \
  --url https://api.cludo.com/api/engine/{engineId}/quicklinks \
  --header 'Authorization: Basic <encoded-value>'

200

[
  {
    "url": "<string>",
    "websiteid": 123,
    "id": 123,
    "terms": [
      {
        "name": "<string>"
      }
    ],
    "brokenLinksFoundAt": "<string>"
  }
]

Authorizations

Authorization · string · header · required

Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5.

Path Parameters

engineId · integer · required

Search engine whose banners, rankings, or quicklinks you are managing.

Response

200

application/json

List of quicklinks for the engine.

url · string · required

Destination when the user selects this quicklink.

websiteid · integer · required

Engine this quicklink belongs to.

id · integer

Quicklink ID (assigned by server on create).

terms · object[]

All trigger phrases for this shortcut.

Show child attributes

brokenLinksFoundAt · string | null

Managed by the Cludo backend; informational only.