Get Forms Submissions
Request
Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
Provide your bearer token in the Authorization header when making requests to protected resources.
Query Parameters
endAt
stringGet submission by ending of this date. By default it will be current date(YYYY-MM-DD).
Examples:
2020-12-14
formId
stringFilter submission by form id
Examples:
jjusM6EOngDExnbo2DbU
limit
numberLimit Per Page records count. will allow maximum up to 100 and default will be 20
Default:
20
Examples:
20
page
numberPage No. By default it will be 1
Default:
1
Examples:
1
q
stringFilter by contactId, name, email or phone no.
Examples:
john@deo.com
startAt
stringGet submission by starting of this date. By default it will be same date of last month(YYYY-MM-DD).
Examples:
2020-11-14
locationId
stringExamples:
ve9EPM428h8vShlRW1KT
Headers
Authorization
stringAccess Token
Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
stringAPI Version
Allowed value:
2021-07-28
Responses
200
Successful response
Body
submissions
array[object]id
stringExample:
38303ec7-629a-49e2-888a-cf8bf0b1f97e
contactId
stringExample:
DWQ45t2IPVxi9LDu1wBl
createdAt
stringExample:
2021-06-23T06:07:04.000Z
formId
stringExample:
YSWdvS4Is98wtIDGnpmI
name
stringExample:
test
email
stringExample:
test@test.com
others
objectmeta
objecttotal
numberExample:
1
currentPage
numberExample:
1
nextPage
number or null
Example:
null
prevPage
number or null
Example:
null
422
Unprocessable Entity
Body
statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity
401
Unauthorized
Body
statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized
400
Bad Request
Body
statusCode
number
Example:
400
message
string
Example:
Bad Request