Quickstart

Make your first authenticated request in a few minutes.

1. Create a secret key

In the dashboard open Developers (or Global API keys) and create a key. The key type follows the workspace you create it in: a key made in your live workspace is an sk_live_* key, and a key made in the Sandbox workspace (use the Sandbox switch in the account menu) is an sk_test_* key that only touches sandbox data. Copy it now - it is shown once.

2. Call the API

Send the key as a Bearer token. This lists your forms:

curl https://app.softsolz.uk/api/v1/services/forms/forms \
  -H "Authorization: Bearer sk_test_your_key"

3. Use an SDK (recommended)

The official SDKs wrap auth, retries and pagination.

npm install @softsolz/sdk

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

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const forms = await client.forms.listForms();
console.log(forms.data);

pip install softsolz

import os
from softsolz import SoftSolz

client = SoftSolz(api_key=os.environ["SOFTSOLZ_API_KEY"])
forms = client.forms.list_forms()
print(forms.data)

4. Go live

Create a key in your live workspace and swap it in for your sk_test_* key. Test keys only ever touch your sandbox workspace, so live data is never returned to a test key.