Endpoint: /accounts
Used for fetching Member Accounts.
List Active Users
Required scope: account.read
Endpoint path: /accounts/activeUsers
Endpoint details: Used for fetching Forms Simplicity user-level accounts that have enabled access for your API integration.
Request: POST
POST https://api.formsimplicity.com/accounts/activeUsers
Request Body
{
"userId" : {vendorEmailId}
"batch_size" : {batch_size},
"batch_no" : {batch_no},
"filter" : {filter},
"incremental_type": {incremental_type},
"incremental_time": {incremental_time}
}
{batch_size} : [optional] size of batch returned (default=20, max=100)
{batch_no} : [optional] batch/page number (default=1)
{filter} : [optional] format: filter=<filtervalue>
e.g if all records need to be fetched, this field should be empty. This is default
if filter=incremental, those members who have enabled this feature after a certain date or time will be fetched
{incremental_type} : if filter=incremental, then this field should be either 'days' or 'hours'
{incremental_time} : Value between 1 and 90. Defaults to 1 if value is less than 0 or greater than 90
Response: SUCCESS
Response Body
{
"meta": {
"total": {total records fetched in this batch},
"max": {total records that match the filter criteria},
"next_batch_no": {next batch number}
},
"data": [{
"agentNRDSID" : {agentNRDSID},
"firstName" : {firstName},
"lastName" : {lastName},
"email" : {email},
"phone" : {phone},
"memberType" : {memberType}
"officeNRDSID" : {officeNRDSID},
"officeName" : {officeName}
}
]
}
Response: ERROR
| Error Code | Error Type |
|---|---|
| 401 Unauthorized | Access Denied |
| 400 Bad Request | Missing Required Parameter |
| 405 Invalid Value in Parameters | Invalid Value in { parameter name} |
See
Exception Documentation
for more details
Get Agent Account Details
Required scope: account.read
Endpoint path: /accounts/getAccount
Endpoint details: Used for fetching the account details of a Forms Simplicity user-level accounts.
Request: POST
POST https://api.formsimplicity.com/accounts/getAccount
Request Body
{
"userId" : {vendorEmailId}
"emailId": {MemberEmailId}
}
Response: SUCCESS
Response Body
[
{
"accountID" : "{accountID}",
"firstName" : "{firstName}",
"lastName" : "{lastName}",
"email" : "{email}",
"phone" : "{phone}",
"memberType": "{memberType}"
}
]
Response: ERROR
| Error Code | Error Type |
|---|---|
| 401 Unauthorized | Access Denied |
| 400 Bad Request | Missing Required Parameter |
See
Exception Documentation
for more details
Form Simplicity API Documentation