Skip to main content
GET
/
web
/
inquiry
List Web inquiries
curl --request GET \
  --url https://platform.inklink.com/api/v1/web/inquiry \
  --header 'api-key: <api-key>'
{
  "data": [
    {
      "id": "web_iq_xxxxxxxxxxxxxxxx",
      "template_id": "web_tpl_xxxxxxxxxxxxxxxx",
      "template_key": "web_tpl_key_xxxxxxxxxxxxxxxx",
      "template_version": 1,
      "name": "Example inquiry",
      "description": "",
      "query": "Example query",
      "fields": [],
      "user_instruction": "",
      "acceptance_guide": "## High Acceptance\n* Example.",
      "start_url": "https://example.com",
      "return_url": "https://your-app.com/complete",
      "capture_type": "document",
      "settings": {
        "show_acceptance_guide": true
      },
      "max_retries": 3,
      "metadata": null,
      "expires_at": "2026-01-20T12:00:00.000Z",
      "created_at": "2026-01-15T10:00:00.000Z",
      "updated_at": "2026-01-15T10:00:00.000Z",
      "deleted_at": null,
      "subject_id": "user_123",
      "result": {
        "id": "web_res_xxxxxxxxxxxxxxxx",
        "inquiry_id": "web_iq_xxxxxxxxxxxxxxxx",
        "status": "pending",
        "acceptance": null,
        "acceptance_reason": null,
        "confidence": null,
        "confidence_reason": null,
        "claims": [],
        "error": null,
        "retry_count": 0,
        "submitted_at": null,
        "completed_at": null,
        "created_at": "2026-01-15T10:00:00.000Z",
        "updated_at": "2026-01-15T10:00:00.000Z"
      }
    }
  ],
  "first_id": "web_iq_xxxxxxxxxxxxxxxx",
  "last_id": "web_iq_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

limit
integer
default:25

Max items per page (1-100). Default 25.

Required range: 1 <= x <= 100
after_id
string

Keyset cursor: a web inquiry id in your organization. When set, the list returns rows strictly older than that inquiry. 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.

Response

Page of inquiries with nested result objects.

data
object[]
first_id
string | null

Id of the first inquiry in data (newest in the page), or null when data is empty.

last_id
string | null

Id of the last inquiry in this page, or null when data is empty. Use as after_id to fetch the next page.

has_more
boolean

True when more rows exist after this page.