Skip to main content
GET
/
web
/
template
List Web templates
curl --request GET \
  --url https://platform.inklink.com/api/v1/web/template \
  --header 'api-key: <api-key>'
{
  "data": [
    {
      "id": "web_tpl_xxxxxxxxxxxxxxxx",
      "key": "web_tpl_key_xxxxxxxxxxxxxxxx",
      "version": 1,
      "is_latest": true,
      "status": "published",
      "name": "Example template",
      "description": "",
      "query": "What should we verify from the site?",
      "fields": [],
      "user_instruction": "",
      "acceptance_guide": "",
      "start_url": "https://example.com",
      "return_url": "https://your-app.com/web/complete",
      "capture_type": "screenshot",
      "settings": {
        "show_cover_page": true,
        "show_acceptance_guide": false
      },
      "metadata": null,
      "theme_id": null,
      "org_id": "org_xxx",
      "created_by": "user_xxx",
      "published_at": "2026-01-15T10:00:00.000Z",
      "created_at": "2026-01-15T10:00:00.000Z",
      "updated_at": "2026-01-15T10:00:00.000Z",
      "deleted_at": null
    }
  ],
  "first_id": "web_tpl_xxxxxxxxxxxxxxxx",
  "last_id": "web_tpl_xxxxxxxxxxxxxxxx",
  "has_more": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.inklink.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

api-key
string
required
Example:

"secret_live_xxx"

Query Parameters

after_id
string

Keyset cursor: a template row id in your organization. When set, the list returns rows strictly older than that row. For the next page, use the previous page last_id. If the id is missing or not in your org, the response is validation error INVALID_AFTER_ID on after_id.

limit
integer
default:25

Page size (1–100, default 25).

Required range: 1 <= x <= 100

Response

Paginated template rows.

data
object[]
first_id
string | null
last_id
string | null
has_more
boolean