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

TimeStatusUser Agent

Make a request to see history.

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

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.siteBuilder.getProjectSiteForms('<id>');
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": [
    {
      "id": "string",
      "page": "string",
      "page_label": "string",
      "title": "string",
      "slot": "string",
      "fields": []
    }
  ]
}