🔗Forms

Retrieve an overview list of all form cases from your website

get

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

Authorizations

SessionKeySiteID

Path parameters

formstringrequired

The form ID which the cases are linked to.

Example: 1

Query parameters

per_pageinteger

Number of items to retireve, maximum of 500

Example: 20

sort_typestring

Property by which to sort the results

Example: created_at

sort_orderstring

Order of results (asc or desc)

Example: desc

pageint

Page to retrieve number, to be used with per_page

Example: 1

filterobject[]

Filter cases on custom fields

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/forms/{form}/cases' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Retrieve all data about an individual form case

get

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

Authorizations

SessionKeySiteID

Path parameters

formstring · idrequired

The ID of your form

Example: 1

idstring · idrequired

The ID of the case

Example: 1234

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/forms/{form}/cases/{id}' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Create a case against a specific user

post

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

Authorizations

SessionKeySiteID

Path parameters

formstring · idrequired

The ID of your form

Example: 1

Body

userIDstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/site/forms/{form}/cases/create' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "userID": "text"
  }'

200

401

403

404

422

200

No body

OK