Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.surefeedback.com/llms.txt

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

​
Step 1: Get an API key

  1. Log in to SureFeedback
  2. Go to Profile → API Keys
  3. Click + Create API Key
  4. Name it, set Read permission, and click Create
  5. Copy your sf_... key — it’s shown only once

​
Step 2: Make your first request

Fetch all sites in your active project: 
curl  https://api.surefeedback.com/api/v1/sites \
  -H "X-API-Key: sf_your_api_key_here"
Response: 
{
  "success": true,
  "data": [
    {
      "id": "880e8400-e29b-41d4-a716-446655440003",
      "name": "Main Website",
      "domain": "example.com",
      "is_active": true
    }
  ]
}

​
Step 3: Fetch comments for a site

curl "https://api.surefeedback.com/api/v1/comments?site_id=SITE_ID&route=/&device_type=DESKTOP" \
  -H "X-API-Key: sf_your_api_key_here"

​
Step 4: Resolve a comment

Requires a key with Write permission: 
curl -X PUT  https://api.surefeedback.com/api/v1/comments/COMMENT_ID/status \
  -H "X-API-Key: sf_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"status": "RESOLVED"}'

​
Step 5: Approve a page

curl -X POST  https://api.surefeedback.com/api/v1/sites/SITE_ID/approvals/approve \
  -H "X-API-Key: sf_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"page_url": "https://example.com/home"}'
That’s it. No login, no token exchange — just your API key on every request.

Authentication details

Learn about permissions and key security.

Webhooks

Receive real-time events for new comments and approvals.