All docs

API reference: Sample workspace

Add example data to every product, see what the workspace holds, and remove it again.

Updated . 2 min read.

A new workspace is easier to judge with something in it. The sample workspace adds example data to every product your plan includes: a contact form with three responses, a survey with responses, a funnel with responses, a poll with votes, a Bio Page, a booking page, two short links, and CRM contacts, companies and deals.

Everything is flagged sample. Sample data never counts toward plan limits, never appears in dashboard totals, analytics or exports, never starts an automation, webhook or email, and never counts as a first outcome. Only the example contact form is public; everything else is a draft until you publish it. Products your plan does not include are skipped.

Base URL: https://formspring.io/api/v1

Method Path Ability
GET /sample-workspace account:read
POST /sample-workspace account:write
DELETE /sample-workspace account:write

Adding and removing need a workspace owner or administrator, and both are queued: the answer is 202 with the current counts and queued: true.

json
{
  "data": {
    "present": true,
    "queued": false,
    "counts": { "forms": 1, "surveys": 1, "funnels": 1, "polls": 1, "bio_pages": 1, "bookings": 1, "links": 3, "contacts": 3, "companies": 2, "deals": 2 }
  }
}

Adding is safe to repeat: a product that already has sample data is left alone. Removing hands every sample row to the product's own queued delete job; real data is never touched, only rows flagged sample.

The same actions are available to agents as get_sample_workspace, add_sample_workspace and remove_sample_workspace, and from Settings, Sample data in the dashboard.