Skip to content
ShopAssist Docs
APIAPI referenceKnowledge base

List Documents

Knowledge documents of the store (newest first).

GET/v1/stores/{store_id}/knowledge/documentsScope knowledge:read

Knowledge documents of the store (newest first).

Parameters

Parameters of List Documents
NameInTypeDescription
store_idrequiredpathstring
limitqueryintegerPage size
cursorquerystring | nullCursor from the previous page

Example request

curl -X GET "https://api.shopassist.coec.dk/v1/stores/sto_01j8000000e008000000000000/knowledge/documents" \
  -H "Authorization: Bearer $SHOPASSIST_API_KEY"

Response 200 (Page_KnowledgeDocument_)

Response of List Documents
FieldTypeDescription
datarequiredKnowledgeDocument[]
data[].chunk_countrequiredinteger
data[].content_previewrequiredstring
data[].doc_typerequiredstring (enum)one of policy, page, faq, file, blog, size_chart, other
data[].fetched_atrequiredstring | nullformat date-time
data[].idrequiredstringpattern `^kdoc_[0-9a-hjkmnp-tv-z]{26}$`
data[].injection_flagsrequiredInjectionFlag[]
data[].injection_flags[].excerptrequiredstring
data[].injection_flags[].rulerequiredstring
data[].localerequiredstring | null
data[].pending_changerequiredPendingChange | null
data[].pending_change.diff_previewrequiredstring
data[].pending_change.reasonrequired"off_domain" | "crawled_policy" | "content_changed" | "mass_change"
data[].pending_change.sincerequiredstringformat date-time
data[].policy_typerequiredstring (enum) | nullone of refund, return, shipping, privacy, terms, contact, legal_notice, subscription, withdrawal, other
data[].review_statusrequired"approved" | "pending_review" | "rejected"
data[].source_idrequiredstringpattern `^ksrc_[0-9a-hjkmnp-tv-z]{26}$`
data[].statusrequired"active" | "excluded" | "error"
data[].titlerequiredstring
data[].updated_atrequiredstringformat date-time
data[].urlrequiredstring | nullformat uri · ≤ 2048 characters
has_morerequiredboolean
next_cursorrequiredstring | nullOpaque cursor for the next page; null on the last page
{
  "data": [
    {
      "chunk_count": 1,
      "content_preview": "string",
      "doc_type": "policy",
      "fetched_at": "2026-09-28T10:15:30.123Z",
      "id": "kdoc_01j8000000e008000000000000",
      "injection_flags": [
        {
          "excerpt": "string",
          "rule": "string"
        }
      ],
      "locale": "da-DK",
      "pending_change": {
        "diff_preview": "string",
        "reason": "off_domain",
        "since": "2026-09-28T10:15:30.123Z"
      },
      "policy_type": "refund",
      "review_status": "approved",
      "source_id": "ksrc_01j8000000e008000000000000",
      "status": "active",
      "title": "string",
      "updated_at": "2026-09-28T10:15:30.123Z",
      "url": "https://shop.example/products/linen-shirt"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Errors

Every error uses the error envelope; the code field is stable.

  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found
  • 422 Unprocessable Content
  • 429 Too Many Requests

Last updated on