You’d like to keep track of your Enboarder form data submitted by users in your company’s analytics platform? Or send employee responses into your HRIS? With our latest API update you can do exactly this: Automatically pull data from Enboarder for systems such as Tableau, Looker, Sisense or any HRIS.

This page contains information for different end points to export Forms reports.

Base URLs

AU 🇦🇺 : https://api.syd.e1.enboarder.com

EU 🇪🇺 : https://api.fra.e1.enboarder.com

US 🇺🇸 : https://api.ore.e1.enboarder.com

Authorization:
All API requests must include a Header Key called "apikey" with a custom value that can be found in your account Settings. To find this value, navigate to Settings > Integration > Our Extensions

Form List  

Report End Point: {{baseURL}}/reports/forms

HTTP Method: GET

Description: To get list of forms with below details

  • id - form unique id

  • name - Form name

Response: 

An array of form names along with IDs

{
    "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 

Report End Point:  {{baseURL}}/reports/forms/{id}/properties

HTTP Method: GET

Description: To get list of form questions information

Params:

id - the id of form

Response:

An array of form fields  and its meta data:

{
  "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 Data

Report End Point: {{baseURL}}/reports/forms/{id}/data

HTTP Method: GET

Description: To get all form fields and responses, along with configured custom fields and categories in associated workflow.

Params:

  •  id - the id of form

  •  select - this is optional parameter.  Comma separated list of form field names which needs to send in response. By default it will return all fields

  • nextKey - 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=2020020614163Kex42oMoh

Response: 

       A array of forms with its fields

{
  "count": 2,
  "id": "4mkVzc9OX"
  "name": "Form: Assign Buddy / Greeter",
  "items": [
    {
      "submitDate": "2020-03-05T02:10:45+0000",
      "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",
      "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"
}


You’d like to keep track of your Enboarder workflow data in your company’s analytics platform? With our latest API update you can do exactly this: Automatically feed data from Enboarder to systems such as Tableau, Looker or Sisense. Check out the Export Workflows API article here:

Did this answer your question?