Siteglide.comAdminRoadmap

Forms

Retrieve an overview list of all form cases from your website

get
Authorizations
x-api-keystringRequired
x-site-idstringRequired
Path parameters
formstringRequired

The form ID which the cases are linked to.

Example: 1
Query parameters
per_pageintegerOptional

Number of items to retireve, maximum of 500

Example: 20
sort_typestringOptional

Property by which to sort the results

Example: created_at
sort_orderstringOptional

Order of results (asc or desc)

Example: desc
pageintOptional

Page to retrieve number, to be used with per_page

Example: 1
filterobject[]Optional

Filter cases on custom fields

Responses
200

OK

No content
get
/forms/{form}/cases
No content

Retrieve all data about an individual form case

get
Authorizations
x-api-keystringRequired
x-site-idstringRequired
Path parameters
formstring · idRequired

The ID of your form

Example: 1
idstring · idRequired

The ID of the case

Example: 1234
Responses
200

OK

No content
get
/forms/{form}/cases/{id}
No content

Create a case against a specific user

post
Authorizations
x-api-keystringRequired
x-site-idstringRequired
Path parameters
formstring · idRequired

The ID of your form

Example: 1
Body
userIDstringRequired
Responses
200

OK

No content
post
/forms/{form}/cases/create
No content
PreviousSite APINextCategories

Last updated

Was this helpful?