Siteglide.comAdminRoadmap

Forms

Retrieve an overview list of all form cases from your website

get
Authorizations
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
GET /api/site/v2/forms/{form}/cases HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Accept: */*

No content

Retrieve all data about an individual form case

get
Authorizations
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}
GET /api/site/v2/forms/{form}/cases/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Accept: */*

No content

Create a case against a specific user

post
Authorizations
Path parameters
formstring · idRequired

The ID of your form

Example: 1
Body
userIDstringRequired
Responses
200

OK

No content
post
/forms/{form}/cases/create
POST /api/site/v2/forms/{form}/cases/create HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "userID": "text"
}
No content

PreviousSite APINextCategories

Last updated

Was this helpful?