Skip to main content
All CollectionsEnboarder API DocsWorkflow Data
Enboarder API Docs: Forms Details
Enboarder API Docs: Forms Details

This API contains different end points to export Forms list, Form properties and Form data.

Adam Faludi avatar
Written by Adam Faludi
Updated over a week ago

Enboarder always strives to empower through efficiency! πŸ₯³
​
This API doc covers the following topics below, feel free to click on the hyperlink to skip to that section. βœ”


Form List Endpoint

Base URL:

AU πŸ‡¦πŸ‡Ί : https://api.syd.e1.enboarder.com

CA πŸ‡¨πŸ‡¦ : https://api.can.e1.enboarder.com

Report End Point:

  • {{baseURL}}/reports/forms

  • Using OAuth Token: {{baseURL}}/reports/v2/forms

HTTP Method: GET

Description: To get a list of forms with the following details.

  • id - form unique id

  • name - Form name

Response Notes:

An array of form names along with IDs

Sample Response:

{
"count": 4,
"items": [
{
"id": "4mkVzc9OX",
"name": "Technology request"
},
{
"id": "4vidsItgn",
"name": "My enquiry form"
},
{
"id": "bWo0G4LE7",
"name": "Add buddy"
},
{
"id": "vdoq2nDUD",
"name": "Send profiles"
}
]
}


Form Properties Endpoint

Base URL:

Report End Point:

  • {{baseURL}}/reports/forms/{id}/properties

  • Using OAuth Token: {{baseURL}}/reports/v2/forms/{id}/properties

HTTP Method: GET

Description: To get a list of Form questions information.

Params:

id - the id of the form

Response Notes:

An array of form fields and their metadata.

Sample Response:

{
"name": "Technology request",
"id": "4mkVzc9OX",
"fields": [
{
"fieldName": "Employee Name",
"label": "Employee name:",
"datatype": "text",
"isRequired": true
},
{
"fieldName": "empName",
"label": "Employee name:",
"datatype": "text",
"isRequired": true
},
{
"fieldName": "personalEmail",
"label": "Home Email",
"datatype": "email",
"isRequired": true
},
{
"fieldName": "salaryType",
"label": "Salary Duration",
"datatype": "dropdown",
"options": [
"Daily",
"Weekly",
"Monthly"
]
},
{
"fieldName": "Ratings 1",
"label": "Ratings",
"datatype": "rating",
"scaleType": "star",
"scale": "6"
},
{
"fieldName": "Systems",
"label": "Computer Type:",
"datatype": "multiple-choice",
"isRequired": true,
"options": [
"Macbook Pro",
"Macbook Air",
"iMac",
"Windows laptop"
]
},
{
"fieldName": "Monitor",
"label": "Large monitor:",
"datatype": "multiple-choice",
"options": [
"Yes",
"No"
]
},
{
"fieldName": "CertFile",
"label": "Upload Certtificate",
"datatype": "file",
"isRequired": true
},
{
"fieldName": "Software",
"label": "Software:",
"datatype": "multiple-choice",
"options": [
"MS Office",
"Google Apps",
"Adobe Creative Suite",
"Salesforce",
"VPN Access"
]
}
]
}


Form Report Endpoint

Base URL:

Report End Point:

  • {{baseURL}}/reports/forms/{id}/data

  • Using OAuth Token: {{baseURL}}/reports/v2/forms/{id}/data

HTTP Method: GET

Description: To get all form questions and answers, as well as configured custom fields and categories in associated Workflows.

Params (Required):

Attribute Name

Type

Default Value

Description

id

String (Path variable)

The id of form. This is a mandatory parameter.

submitStartDate

String

Current value

Format: yyyy-mm-dd. Ex - 2020-02-14 By default it will put current the date

submitEndDate

String

Current Date - 12 months

Format: yyyy-mm-dd. Ex - 2019-02-14. By default it will put 1 year old date

select

String

all

Comma separated list of form field names which needs to send in response. By default it will return all fields

nextKey

String

The api will return 500 records in response. To get next set of record, please send this value in next request with same filters. Note - If no further records needs to fetch then its value will be blank in response

Sample URL:

/reports/forms/4mkVzc9OX/data?select=name,comments&nextKey=2020020614163Kex42oMo&submitStartDate=2019-12-18&submitEndDate=2020-02-20

Sample Response:

{
"count": 2,
"id": "4mkVzc9OX"
"name": "Form: Assign Buddy / Greeter",
"items": [
{
"submitDate": "2020-03-05T02:10:45+0000",
"submitFormID":"202002270804U9mWymOnX#AyuaIeiDE#4vidsItgn"
"submitBy": "Alok Kumar",
"workflow" {
"id": "N9clmK-BmM",
"name": : "TEST",
"internalID": "202003050207dJpcjjXsR"
}
"formFields": [
{
"question": "Buddy's First & Last Name",
"fieldName": "Buddy Full Name",
"answer": "Buddy",
"type": "text"
},
{
"question": "Buddy's Email Address",
"fieldName": "Buddy email",
"answer": "alok+buddy@enboarder.com",
"type": "email"
}
],
"customFields": [
{
"label": "Company code",
"type": "picklist",
"value": "CC-1"
},
{
"label": "DOB",
"type": "date",
"value": "2019-05-01T00:00:00+00:00"
}
]
},
{
"submitDate": "2020-03-06T07:44:57+0000",
"submitFormID":"202003050207dJpcjjXsR#AyuaIeiDE#5vidsItgn"
"submitBy": "alok+mgr",
"workflow" {
"id": "N9clmK-BmM",
"name": : "TEST",
"internalID": "202003050207dJpcjjXsR"
}
"formFields": [
{
"question": "Buddy's First & Last Name",
"fieldName": "Buddy Full Name",
"answer": "Buddy",
"type": "text"
},
{
"question": "Buddy's Email Address",
"fieldName": "Buddy email",
"answer": "alok+buddy@enboarder.com",
"type": "email"
},
{
"question": "Select Buddy Types",
"fieldName": "Buddy types",
"answer": [
"Engineering",
"Sales"
],
"type": "checkbox"
},
{
"question": "Liked it",
"fieldName": "Ratings 1",
"answer": 10,
"type": "rating"
},
{
"question": "Date of induction",
"fieldName": "Unique 2",
"answer": "2020-03-06",
"type": "date"
},
{
"question": "Communication language",
"fieldName": "language",
"answer": "English",
"type": "dropdown"
}
]
}
],
"nextKey": "202002270804U9mWymOnX#AyuaIeiDE#4vidsItgn"
}


Tags & Descriptions

Tag

Description

Comments

1

id

Id of form definition

2

name

Name of the form definition

3

items -> submitDate

The date when the form is submitted in GMT format

4

items β†’ submitFormID

The id of the form submitted in the database

This is unique for record

5

items β†’ submitBy

The user who submitted the form

6

workflow β†’ id

The Id of associated workflow

7

workflow β†’ name

The name of the associated workflow

8

workflow β†’ internalID

The id of associated workflow launched record

9

formFields β†’ question

This is the question as defined on Form Editor

10

formFields β†’ fieldName

Field name defined on Form Editor

11

formFields β†’ answer

This is the Form question response submitted by the user.

12

formFields β†’ type

the datatype of form item

Possible values are text, date, number, email, mobile, dropdown, radio, check, rating, contact_channel, fileupload

13

customFields β†’ label

The custom field or category defined in the setting section

The custom field or category defined in the setting section

14

customFields β†’ type

The type of custom field defined in setting section

Possible values are date, datetime, text, picklist, number

15

customFields β†’ value

The value of custom field defined in setting section

Got questions? Reach out to the team by clicking the '?' button at the top right of any Enboarder page. 😎

Did this answer your question?