List forms for the tenant.

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

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

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.

archivedstring

Archived forms: all (default), false to leave them out, true for only them.

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.

created_byinteger | nullMember who created the form, when known.

created_by_namestring | nullName of the member who created the form.

submissions_countintegerTotal submissions for this form.

unread_countintegerUnread submissions.

pagesarray of objectsPage titles for a multi-step form, in order: { id, title?, description? }.

logicarray of objectsRules: { id, when: { match, rules: [{ field, operator, value }] }, then: [{ action, target?, value? }] }.

logic_engineintegerRules engine version. New forms use 2; older forms that only use visible_if may be 1.

published_atstring | nullWhen the live version was last published.

has_unpublished_changesbooleanTrue when the working copy differs from the published version.

archived_atstring | nullWhen the form was archived; null when it is not.

share_enabledbooleanWhether the share link is on.

version_idinteger | nullOnly with view=published: the published version id.

Request

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/forms/forms \
  --header 'Authorization: Bearer sk_live_your_key'

Credentials

Authorization

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": 42,
      "slug": "contact-us",
      "name": "Contact Us",
      "description": "Reach our sales team.",
      "field_schema": [
        {
          "id": "full_name",
          "type": "text",
          "label": "Full name",
          "required": true
        }
      ],
      "settings": {
        "success_message": "Thanks!",
        "notify_in_app": true
      },
      "appearance": {
        "accent_color": "#2563eb",
        "theme": "light"
      },
      "status": "published",
      "created_at": "2026-06-01T12:00:00.000Z",
      "updated_at": "2026-06-02T09:30:00.000Z",
      "created_by": 7,
      "created_by_name": "Sam Lee",
      "submissions_count": 128,
      "unread_count": 4,
      "pages": [
        {
          "id": "about_you",
          "title": "About you"
        }
      ],
      "logic": [],
      "logic_engine": 1,
      "published_at": "2026-06-02T09:30:00.000Z",
      "has_unpublished_changes": false,
      "archived_at": null,
      "share_enabled": false,
      "version_id": 3
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  }
}