List forms for the tenant.

GEThttps://staging.softsolz.uk/api/v1/services/forms/forms

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

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

Query Params

statusstring

Filter by status (draft|published|paused).

searchstring

Case-insensitive match against form name or slug.

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Pagination offset (default 0).

Response

Response Body · array of objects

idintegerForm id.

slugstringURL-safe form slug, unique per tenant.

namestringForm display name.

descriptionstring | nullOptional form description.

field_schemaarray of objectsOrdered field definitions. Each item: { id, type, label, required, width, ...type-specific keys }.

settingsobjectForm settings (success_message, notify_in_app, honeypot_enabled, etc.).

appearanceobjectAppearance tokens (colors, theme, font).

statusstringPublish status.

created_atstringCreation timestamp.

updated_atstringLast update timestamp. Round-trip as expected_updated_at to guard against stale writes.

submissions_countintegerTotal submissions for this form.

unread_countintegerUnread submissions.

Request

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

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

const result = await client.forms.listForms({});
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": [
    {
      "id": 0,
      "slug": "string",
      "name": "string",
      "description": "string",
      "field_schema": [],
      "settings": {},
      "appearance": {},
      "status": "string",
      "created_at": "string",
      "updated_at": "string",
      "submissions_count": 0,
      "unread_count": 0
    }
  ]
}