Back to top

FORMBIT

Create beautiful forms and surveys using drag and drop.

Resource Group

Resource

GET/api/v1/forms/{formID}/submissions

Find Submissions for a Form.

Example URI

GET /api/v1/forms/formID/submissions
URI Parameters
HideShow
formID
string (required) 
apikey
string (required) 
Response  200
HideShow
Headers
Content-Type: application/json,
Body
{
  "submissions": [
    {
      "comment": "Look for an email from Tom. ",
      "email": "support@example.com",
      "data": {
        "comment": "Look for an email from Tom. ",
        "email": "support@example.com",
        "lastName": "M",
        "firstName": "Leena"
      },
      "responseUpdatedAt": "2016-10-24T16:21:07.398Z",
      "responseCreatedAt": "2016-10-24T16:21:07.398Z",
      "responseID": "580e34f37f2bbe06957581e0"
    }
  ]
}
Schema
{
  "type": "object"
}
Response  401
HideShow
Headers
Content-Type: application/json,
Body
{
  "code": "fb302",
  "msg": "Unauthorized user."
}
Schema
{
  "type": "object"
}

Resource

GET/api/v1/forms

Get the forms for a user.

Example URI

GET /api/v1/forms
URI Parameters
HideShow
apikey
string (required) 
Response  200
HideShow
Headers
Content-Type: application/json,
Body
[
  {
    "perma_link": "BkXssBByW",
    "allow_submissions": true,
    "multiple_submission": true,
    "disable_after_submission": "",
    "show_profile_link": "false",
    "__v": 0,
    "custom_success_message": "<p>We got your message. Thanks!</p>\r\n",
    "notification_email": "",
    "post_external_endpoint": "",
    "redirect_external_url": "",
    "header": "",
    "description": "Form to accept resume from the applicant.",
    "title": "Resume Upload",
    "workspace_id": "5894a554b65ab70c291ab711",
    "user_id": "5807aaadb3166b06b01bebd1",
    "updatedAt": "2017-05-01T23:58:18.789Z",
    "createdAt": "2017-05-01T23:58:18.789Z",
    "_id": "5907cb9af717cfce0f56c291"
  }
]
Schema
{
  "type": "object"
}
Response  401
HideShow
Headers
Content-Type: application/json,
Body
{
  "code": "fb302",
  "msg": "Unauthorized user."
}
Schema
{
  "type": "object"
}

Resource

GET/api/v1/workspace

Get a single page from the list of all Workspace(s).

Example URI

GET /api/v1/workspace
URI Parameters
HideShow
apikey
string (required) 
Response  200
HideShow
Headers
Content-Type: application/json,
Body
[
  {
    "default": false,
    "__v": 0,
    "title": "Test",
    "user_id": "5807aaadb3166b06b01bebd9",
    "updatedAt": "2017-02-03T15:44:20.687Z",
    "createdAt": "2017-02-03T15:44:20.687Z",
    "_id": "5894a554b65ab70c291ab714"
  },
  {
    "default": true,
    "title": "My Workspace",
    "user_id": "5807aaadb3166b06b01bebd8",
    "_id": "5834be5902c7ab6cd7d2f9e4"
  }
]
Schema
{
  "type": "object"
}
Response  401
HideShow
Headers
Content-Type: application/json,
Body
{
  "code": "fb302",
  "msg": "Unauthorized user."
}
Schema
{
  "type": "object"
}

Resource

GET/api/v1/workspace/{workspaceID}/form

Get a single page from the list of all Workspace’s Forms.

Example URI

GET /api/v1/workspace/workspaceID/form
URI Parameters
HideShow
workspaceID
string (required) 
apikey
string (required) 
Response  200
HideShow
Headers
Content-Type: application/json,
Body
[
  {
    "perma_link": "HJSIzslSROl",
    "allow_submissions": true,
    "multiple_submission": true,
    "disable_after_submission": "5000",
    "form_schema": "{\"components\":[{\"input\":false,\"columns\":[{\"components\":[{\"input\":true,\"tableView\":true,\"inputType\":\"text\",\"inputMask\":\"\",\"label\":\"First Name\",\"key\":\"firstName\",\"placeholder\":\"\",\"prefix\":\"\",\"suffix\":\"\",\"multiple\":false,\"defaultValue\":\"\",\"protected\":false,\"unique\":false,\"persistent\":true,\"validate\":{\"required\":true,\"minLength\":\"\",\"maxLength\":\"\",\"pattern\":\"\",\"custom\":\"\",\"customPrivate\":false},\"conditional\":{\"show\":\"\",\"when\":null,\"eq\":\"\"},\"type\":\"textfield\",\"tags\":[],\"hidden\":false,\"clearOnHide\":true}]},{\"components\":[{\"input\":true,\"tableView\":true,\"inputType\":\"text\",\"inputMask\":\"\",\"label\":\"Last Name\",\"key\":\"lastName\",\"placeholder\":\"\",\"prefix\":\"\",\"suffix\":\"\",\"multiple\":false,\"defaultValue\":\"\",\"protected\":false,\"unique\":false,\"persistent\":true,\"validate\":{\"required\":false,\"minLength\":\"\",\"maxLength\":\"\",\"pattern\":\"\",\"custom\":\"\",\"customPrivate\":false},\"conditional\":{\"show\":\"\",\"when\":null,\"eq\":\"\"},\"type\":\"textfield\",\"tags\":[],\"hidden\":false,\"clearOnHide\":true}]}],\"type\":\"columns\",\"tags\":[],\"conditional\":{\"show\":\"\",\"when\":null,\"eq\":\"\"}},{\"input\":true,\"tableView\":true,\"inputType\":\"email\",\"label\":\"Email\",\"key\":\"email\",\"placeholder\":\"\",\"prefix\":\"\",\"suffix\":\"\",\"defaultValue\":\"\",\"protected\":false,\"unique\":false,\"persistent\":true,\"kickbox\":{\"enabled\":false},\"type\":\"email\",\"tags\":[],\"conditional\":{\"show\":\"\",\"when\":null,\"eq\":\"\"},\"validate\":{\"required\":true,\"minLength\":5},\"hidden\":false,\"clearOnHide\":true},{\"input\":true,\"tableView\":true,\"label\":\"How can we help you today?\",\"key\":\"comment\",\"placeholder\":\"\",\"prefix\":\"\",\"suffix\":\"\",\"rows\":3,\"multiple\":false,\"defaultValue\":\"\",\"protected\":false,\"persistent\":true,\"wysiwyg\":false,\"validate\":{\"required\":false,\"minLength\":\"\",\"maxLength\":\"\",\"pattern\":\"\",\"custom\":\"\"},\"type\":\"textarea\",\"tags\":[],\"conditional\":{\"show\":\"\",\"when\":null,\"eq\":\"\"},\"lockKey\":true,\"hidden\":false,\"clearOnHide\":true},{\"input\":true,\"label\":\"Submit\",\"tableView\":false,\"key\":\"submit\",\"size\":\"md\",\"leftIcon\":\"\",\"rightIcon\":\"\",\"block\":false,\"action\":\"submit\",\"disableOnInvalid\":false,\"theme\":\"primary\",\"type\":\"button\"}],\"display\":\"form\",\"page\":0}",
    "post_external_endpoint": "",
    "header": "<p>You can contact us by filling the form below and we'll get in touch as soon as possible. </p><p><br></p><p><br></p>",
    "workspace_id": "5834be5902c7ab6cd7d2f9e3",
    "__v": 0,
    "footer_link": true,
    "custom_success_message": "<p>We got your message. Thanks!</p>\r\n",
    "notification_email": "",
    "redirect_external_url": "",
    "description": "FormBit's Public Form",
    "title": "Contact Us",
    "user_id": "5807aaadb3166b06b01bebd8",
    "updatedAt": "2017-02-12T20:07:54.197Z",
    "createdAt": "2016-10-24T16:19:22.427Z",
    "_id": "580e348a7f2bbe06957581df"
  }
]
Schema
{
  "type": "object"
}
Response  401
HideShow
Headers
Content-Type: application/json,
Body
{
  "code": "fb302",
  "msg": "Unauthorized user."
}
Schema
{
  "type": "object"
}

Resource

GET/api/v1/user

Validate and authenticate a user by calling the User API.

Example URI

GET /api/v1/user
URI Parameters
HideShow
apikey
string (required) 
Response  200
HideShow
Headers
Content-Type: application/json,
Body
{
  "picture": "",
  "organization": "FormBit",
  "website": "",
  "location": "",
  "gender": "Female",
  "name": "Leena"
}
Schema
{
  "type": "object"
}
Response  401
HideShow
Headers
Content-Type: application/json,
Body
{
  "code": "fb302",
  "msg": "Unauthorized user."
}
Schema
{
  "type": "object"
}

Resource

GET/api/v1/team/{workspaceID}

Get a list of team for a Workspace

Example URI

GET /api/v1/team/workspaceID
URI Parameters
HideShow
workspaceID
string (required) 
apikey
string (required) 
Response  200
HideShow
Headers
Content-Type: application/json,
Body
[
  {
    "permission": [
      "formDuplicate",
      "formEdit",
      "formDelete",
      "formLock",
      "responseNew",
      "responseView",
      "responseEdit",
      "responseDelete",
      "responseExport",
      "responseComment"
    ],
    "__v": 0,
    "workspace_id": "5834be5902c7ab6cd7d2f9e2",
    "user_id": "5807aaadb3166b06b01bebd8",
    "authorized_user_id": "5807aaadb3166b06b01bebd8",
    "updatedAt": "2017-06-09T17:26:39.174Z",
    "createdAt": "2017-06-09T17:26:39.174Z",
    "_id": "593ada4fa935032f10ff1e9f"
  }
]
Schema
{
  "type": "object"
}
Response  401
HideShow
Headers
Content-Type: application/json,
Body
{
  "code": "fb302",
  "msg": "Unauthorized user."
}
Schema
{
  "type": "object"
}

Generated by aglio on 12 Jun 2017