SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Find the HTML forms already designed into the pages so they can be connected as SoftSolz forms

Pass a candidate to POST /projects/{id}/integrations as resource.create_form = { name, fields } to publish a SoftSolz form with exactly those field ids, so the designed markup posts through unchanged.

GEThttps://app.softsolz.uk/api/v1/services/site-builder/projects/{id}/site-forms

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 · array of objects

idstringCandidate id.
pagestringPage holding the form.
page_labelstringHuman page label.
titlestringHeading nearest the form.
slotstring | nullService slot the form sits in, if any.
fieldsarray of objectsInputs found: { id, name, label, type, required, options }.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/site-builder/projects/{id}/site-forms \
--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": "contact.html#0",
"page": "contact.html",
"page_label": "Contact",
"title": "Get in touch",
"slot": null,
"fields": [
{
"id": "email",
"name": "email",
"label": "Email",
"type": "email",
"required": true
}
]
}
]
}