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 pull data from Enboarder for systems such as Tableau, Looker or Sisense.

This page contains information for different end points to export workflow 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

Workflow List Report:


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

HTTP Method: GET

Description: To get a list of workflow names and their ID's

Response:

 A array of workflow with below detail

  • id - Workflow unique id
  • name - Workflow name
  • IsActive - Status of  workflow 
{
    "count": 3,
    "items": [
      {
        "id": "O0lMYAwSv",
        "name": "Rest API Testing",
        "isActive": true
      },
      {
        "id": "Vr4Q_-ttA",
        "name": "Default Workflow",
        "isActive": true
      },
      {
        "id": "hx3cBcdvF",
        "name": "Rest API Testing",
        "isActive": false
      }
    ]
}

Workflow Properties Report

Base URLs

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

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

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


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

HTTP Method: GET

Description: To get list of column list including categories, custom fields configured for this workflow

Param :

An array of columns names and types.

{
  "name": "Sydney Series Test (10AM)",
  "id": "Nym2o7QcZ",
  "fields": [
    {
      "id": "HyXP8GBbOW",
      "label": "Color Value",
      "type": "customField",
      "datatype": "picklist",
      "options": [
        {
          "id": "Blue_SybPUMHbO-",
          "value": "Blue"
        },
        {
          "id": "Green_B1lDLfB-dZ",
          "value": "Green"
        },
        {
          "id": "Orange_HyGwLGSZd-",
          "value": "Orange"
        },
        {
          "id": "Red_B1vUzSWO-",
          "value": "Red"
        }
      ]
    },
    {
      "id": "SyEfMSZd-",
      "label": "Counter",
      "type": "customField",
      "datatype": "number"
    },
    {
      "id": "rkmPfSWO-",
      "label": "Description",
      "type": "customField",
      "datatype": "text"
    },
    {
      "id": "rJv7MrZu-",
      "label": "Reporting Date",
      "type": "customField",
      "datatype": "date"
    },
    {
      "id": "SJWEMBW_b",
      "label": "Reporting Time",
      "type": "customField",
      "datatype": "datetime"
    },
    {
      "id": "NJ8MAOqUJZ",
      "label": "Teacher",
      "type": "manager",
      "datatype": "variable"
    },
    {
      "id": "V161uKSS-",
      "label": "IT manager",
      "type": "manager",
      "datatype": "variable",
      "isRequired": true
    },
    {
      "id": "4yczutrSZ",
      "label": "HR manager",
      "type": "manager",
      "datatype": "variable",
      "isRequired": true
    },
    {
      "id": "Vkc2ZTBUZ",
      "label": "Payroll",
      "type": "manager",
      "datatype": "fixed",
      "isRequired": true
    }
  ]
}

Workflow Report with ID

Base URLs

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

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

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

End Point:  {{baseURL}}/reports/workflows/{id}/data

HTTP Method: GET

Description: To get list of workflow for a particular workflow id. By default return 1 year old data for selected workflow

Request Params (Optional):

/reports/workflows/hx3cBcdvF/data?launchStartDate=2019-12-18&launchEndDate=2020-02-20&nextKey=2020020614163Kex42oMoh

Attribute Name

Type

Default Value

Description

{
  "count": 3,
  "workflow": "TestBambooWebhook",
  "id": "hx3cBcdvF",
  "items": [
    {
      "id": "202003180404Agh5PhEAV",
      "employee": "test launch",
      "mobile": "+9198XXXXXXXX",
      "email": "vneet+tanag@enboarder.com",
      "status": "in progress",
      "startDate": "2020-03-18T12:00:00",
      "launchDate": "2020-03-18T04:04:27",
      "mode": "live",
      "workflow": {
        "id": "GLQeB7C27",
        "name": "Asad - test Sutherland form signature stories"
      },
       "customFields": [
        {
          "id": "brand",
          "label": "Brand",
          "type": "category",
          "datatype": "text",
          "value": {
            "id": "val_brand_imaPy3ot0",
            "val": "David Jones"
          }
        },
        {
          "id": "location",
          "label": "Location",
          "type": "category",
          "datatype": "text",
          "value": {
            "id": "val_location_4yMrck7S-",
            "val": "Sydney"
          }
        },
        {
          "label": "Office Report Time",
          "type": "category",
          "datatype": "datetime",
          "value": {
            "id": "N18JrS6Y-",
            "val": "09:30"
          }
        },
        {
          "label": "Reporting Date",
          "type": "category",
          "datatype": "date",
          "value": {
            "id": "rJv7MrZu-",
            "val": "2020-03-18T12:00:00"
          }
        }
      ],
      "managers": [
        {
          "id": "M_keuaCHIq",
          "type": "manager",
          "datatype": "Variable",
          "value": {
            "name": "Shuchi Manager",
            "email": "catchshuchi+it@gmail.com",
            "phone": "+91XXXXXXXXXX",
            "preferedChannel": "eml"
          }
        }
      ]
    }
    ...........
  ],
  "nextKey": "2020020614163Kex42oMoh"
}


Workflow report

Base URLs

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

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

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

End Point:  {{baseURL}}/reports/workflows/data

HTTP Method: GET

Description: To get list of workflow based on parameter configured. By default return 1 year old data.

Request Params (Optional):

/reports/workflows/data?launchStartDate=2019-12-18&launchEndDate=2020-02-20&nextKey=2020020614163Kex42oMoh


Response:

{
  "count": 3,
  "workflow": "TestBambooWebhook",
  "id": "hx3cBcdvF",
  "items": [
    {
      "id": "202003180404Agh5PhEAV",
      "employee": "test launch",
      "mobile": "+9198XXXXXXXX",
      "email": "vneet+tanag@enboarder.com",
      "status": "in progress",
      "startDate": "2020-03-18T12:00:00",
      "launchDate": "2020-03-18T04:04:27",
      "mode": "live",
      "workflow": {
        "id": "GLQeB7C27",
        "name": "Asad - test Sutherland form signature stories"
      },
       "customFields": [
        {
          "id": "brand",
          "label": "Brand",
          "type": "category",
          "datatype": "text",
          "value": {
            "id": "val_brand_imaPy3ot0",
            "val": "David Jones"
          }
        },
        {
          "id": "location",
          "label": "Location",
          "type": "category",
          "datatype": "text",
          "value": {
            "id": "val_location_4yMrck7S-",
            "val": "Sydney"
          }
        },
        {
          "label": "Office Report Time",
          "type": "category",
          "datatype": "datetime",
          "value": {
            "id": "N18JrS6Y-",
            "val": "09:30"
          }
        },
        {
          "label": "Reporting Date",
          "type": "category",
          "datatype": "date",
          "value": {
            "id": "rJv7MrZu-",
            "val": "2020-03-18T12:00:00"
          }
        }
      ],
      "managers": [
        {
          "id": "M_keuaCHIq",
          "type": "manager",
          "datatype": "Variable",
          "value": {
            "name": "Shuchi Manager",
            "email": "catchshuchi+it@gmail.com",
            "phone": "+61XXXXXXXXX",
            "preferedChannel": "eml"
          }
        }
      ]
    }
  ],
  "nextKey": "2020020614163Kex42oMoh"
 }
  ....
],
  "nextKey": "2020020614163Kex42oMoh"
}

Like to keep track of your Enboarder form data submitted by users in your company’s analytics platform? With our latest API update you can do exactly this! Check out the Export Forms API article here:

Did this answer your question?