🔗Forms

Retrieve an overview list of all form cases from your website

GET/api/public/site/forms/{form}/cases

Authorization

SessionKey

Path parameters

form*string

The form ID which the cases are linked to.

Example: 1

Query parameters

Response

200401403404422

OK

Request

JavaScriptCurlPython

const response = await fetch('/api/public/site/forms/{form}/cases', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Retrieve all data about an individual form case

GET/api/public/site/forms/{form}/cases/{id}

Authorization

SessionKey

Path parameters

form*string (id)

The ID of your form

Example: 1

id*string (id)

The ID of the case

Example: 1234

Response

200401403404422

OK

Request

JavaScriptCurlPython

const response = await fetch('/api/public/site/forms/{form}/cases/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create a case against a specific user

POST/api/public/site/forms/{form}/cases/create

Authorization

SessionKey

Path parameters

form*string (id)

The ID of your form

Example: 1

Body

application/json

Your Cases custom fields as a JSON object

userID*string

Response

200401403404422

OK

Request

JavaScriptCurlPython

const response = await fetch('/api/public/site/forms/{form}/cases/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userID": "text"
    }),
});
const data = await response.json();