Artisan IMG > Sapling (sapling) (96ecbc77-8325-41b8-960a-b5608c3cfa61)


Sapling is a People Operations Platform that elevates the entire employee experience.


Sapling is a cloud-based human resource (HR) management solution designed to assist in employee onboarding and managing HR operations.


When using the Sapling connector, the first thing you will need to do is go to your account page, and select the workflow you wish to work on. Once in the workflow builder itself, search and drag the Sapling connector from the connectors panel (on the left hand side) onto your workflow.

With the new Sapling connector step highlighted, in the properties panel on the right, click on the ‘Authenticate’ panel followed by ‘Add new Authentication’ (located under the Authentication input field).

This will result in a authentication pop-up window. The first page will ask you to name your authentication, and state which type of authentication you wish to create ('Personal' or 'Organisational').

As you can see, the next page asks you for your 'API key' and 'Subdomain' credentials.

In order to get The API key, head to your Sapling dashboard. Click on the 'Integrations' and navigate to the 'API Keys' tab. Copy an existing API key, or click on the “Create New Key” button to generate a new one.

The subdomain is your company's subdomain of your Sapling account (e.g.,

Once you have added these fields to your authentication popup window, click on the 'Create authentication' button. Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Using the Raw HTTP Request ('Universal Operation')

As of version v.1, you can effectively create your own operations.

This is a very powerful feature which you can put to use when there is an endpoint in Sapling which is not used by any of our operations.

To use this you will first of all need to research the endpoint in the Sapling API documentation v1.9, to find the exact format that Sapling will be expecting the endpoint to be passed in.

Note that you will only need to add the suffix to the endpoint, as the base URL will be automatically set (the base URL is picked up from the value you entered when you created your authentication).

The base URL for Sapling is: https://{{subdomain}}

For example, say that the 'List users' operation did not exist in our Sapling connector, and you wanted to use this endpoint, you would use the Sapling API docs to find the relevant endpoint - which in this case is a GET request called: /profiles.

More details can be found here.

As you can see there is also the option to include a query parameter, should you wish to do so. For this example, we will set the limit parameter to 10 to retrieve 10 users from the API. So if you know what your method, endpoint and details of your query parameters are, you can get the list of the first 10 users with the following settings:

Method: GET

Endpoint: /profiles

Query Parameter: Key: limit Value: 10

Body Type : none

Final Example outcome being: https://{{subdomain}}

Example Usage

TRAY POTENTIAL: is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with and the Sapling connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

Below is an example of a way in which you could potentially use the Sapling connector, to get the user information.

The steps will be as follows:

  1. Setup using a manual trigger and list users in your account

  2. Add the Loop collection connector to iterate over each individual user.

  3. Gather the information available for each user.

The final outcome should look like this:

1 - Setup Trigger & List users

Once you have clicked 'Create new workflow' from your main dashboard named it, select the Manual trigger from the trigger options available:

After you have been redirected to the workflow dashboard, from the connectors panel on the left, add a Sapling connector to your second step. Set the operation to 'List users'.

You will notice that there are a lot of additional configuration fields that you can set on this operation ('Status', 'Location', 'Department', Manager, etc). While none of these are mandatory, please feel free to add them according to your project needs.

Please note that the 'Limit' and 'Page' fields are already pre-filled for you, so you need not worry about it at this stage.

Feel free to re-name your steps as you go along to make things clearer for yourself and other users.

Now when this workflow is run, it will retrieve a list of users from the Sapling API.

2 - Add a loop collection

Next, search for the 'Loop collection' connector within your connector panel, and drag it into your workflow as your next step. Set your operations to 'Loop list'.

The Loop Collection connector allows you to iterate through a list of results. In this example, we will use it to iterate through the data found within the previous Sapling connector step.

In order to specify the list you want to loop through, start by using the 'List' mapping icon (found next to the list input field, within the properties panel) to generate the connector-snake.

While hovering over the 'List users' step (with the tail end of the connector-snake), select users from the list of output properties displayed. This will auto-populate a jsonpath within your 'List' input field, and update the type selector to jsonpath.

For more clarification on the pathways you have available, open the Debug panel to view your step's Input and Output.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with, please see our pages on Basic data concepts and Mapping data between steps

CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

This will enable us to iterate over the list of users, and perform operations for each one, during each loop cycle.

3 - Get user

The last step is to drag a Sapling connector inside of the Loop Collection step itself. Set the operation to 'Get user'. As you can see, the 'GUID' field is required. Use the same connector-snake method for generating the JSON path to get the 'GUID'.

Now when this workflow is run, you will be able to gather the information available for each user. This means you will be able to view the user's details when you click through your debug panel and expand the output.

BEST PRACTICES: Whenever you do decide to create your own workflow, be sure to check out some of our key articles such as: