SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Launchpad

Read one client, its build progress and its preview address

Poll it after POST /clients/{id}/build: build_steps shows each step and status turns ready or failed. 404 client_not_found when the id is not one of your clients.

GEThttps://app.softsolz.uk/api/v1/services/launchpad/clients/{id}

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Response

Response Body

idstringClient id. Use it in every /clients/{id} call.
workspace_idstringThe client workspace created for the business.
company_namestringBusiness name.
contact_namestring | nullPerson at the business you deal with.
contact_emailstring | nullEmail address the claim link is sent to by default.
website_urlstring | nullThe business current website, read during the build.
industrystring | nullWhat the business does.
descriptionstring | nullShort description of the business.
locationstring | nullWhere the business is.
public_emailstring | nullEmail address shown on the website.
public_phonestring | nullPhone number shown on the website.
has_knowledge_textbooleanWhether facts for the chatbot and the website text were given.
starter_idstringTemplate the website uses.
servicesarray of stringsServices the build adds to the website.
logo_sourcestringWhere the logo comes from.
agency_role_namestringRole your team keeps in the client workspace after the business takes over.
handover_modestringstay keeps your team in the workspace with agency_role_name after the business takes over; leave removes your access.
statusstringdraft (not built yet), building, ready (built, not sent), failed (build stopped, build again), sent (claim link or invite sent), signed_up (the business signed up and has not chosen a plan yet), claimed (the business runs the workspace; Launchpad can no longer change it).
build_errorstring | nullWhy the last build stopped, or null.
build_stepsarray of objectsBuild progress, one entry per step. Empty until the first build.
preview_ends_atstring | nullWhen the free preview ends.
preview_days_leftinteger | nullWhole days left in the preview; null once the business has taken over.
sent_atstring | nullWhen the claim link or invite was first sent.
reminder_sent_atstring | nullWhen the preview reminder was sent.
opted_out_atstring | nullWhen the business asked not to be emailed about this again.
signed_up_atstring | nullWhen the business signed up.
claimed_atstring | nullWhen the business took over the workspace.
handover_emailstring | nullEmail address a set-your-password link was sent to.
handover_sent_atstring | nullWhen the set-your-password link was sent.
notesstring | nullYour private notes about the client.
claim_urlstring | nullLink the business opens to claim the workspace. Null until the workspace is built, and after the business opts out or takes over.
siteobject | nullThe client website, or null until the build creates it.
created_atstringWhen you started setting the business up.
updated_atstringLast change.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/launchpad/clients/{id} \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"id": "6f1c2b9e-4d3a-4b8e-9c1d-2a7e5f0b3c4d",
"workspace_id": "0b7d5e3a-9c2f-4a1e-8d6b-5f4c3a2e1d0c",
"company_name": "Northwind Bistro",
"contact_name": "Maya Patel",
"contact_email": "maya.patel@example.com",
"website_url": null,
"industry": "Restaurant",
"description": "A neighbourhood bistro serving seasonal small plates.",
"location": "Bristol, UK",
"public_email": "hello@northwindbistro.co.uk",
"public_phone": "+44 117 496 0123",
"has_knowledge_text": true,
"starter_id": "restaurant",
"services": [
"forms",
"newsletter",
"blogs",
"smart-chat",
"appointments"
],
"logo_source": "none",
"agency_role_name": "manager",
"handover_mode": "stay",
"status": "draft",
"build_error": null,
"build_steps": [],
"preview_ends_at": "2026-10-15T10:15:00.000Z",
"preview_days_left": 14,
"sent_at": null,
"reminder_sent_at": null,
"opted_out_at": null,
"signed_up_at": null,
"claimed_at": null,
"handover_email": null,
"handover_sent_at": null,
"notes": "Met at the Clifton food market.",
"claim_url": null,
"site": {
"address": "3f9a1c7e5b2d4e60",
"status": "published",
"url": null,
"published_at": "2026-09-24T10:15:00.000Z",
"has_logo": false
},
"created_at": "2026-10-01T10:15:00.000Z",
"updated_at": "2026-10-01T10:15:00.000Z"
}
}