> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Humanity Connector

## Intro

Humanity (formerly called ShiftPlanning) is an online workforce management and scheduling system designed to help users easily manage time clock, attendance, human resources and payroll. Use Domo's Humanity connector to retrieve data about schedules, employees, notifications, and so on. For more information about the Humanity API, visit their website. ([https://www.Humanity.com/api/](https://www.shiftplanning.com/api/ "https://www.shiftplanning.com/api/") )

The Humanity connector is a "Cloud App" connector, meaning it retrieves data stored in the cloud. In the Data Center, you can access the connector page for this and other Cloud App connectors by clicking **Cloud App** in the toolbar at the top of the window.

You connect to your Humanity account in the Data Center. This topic discusses the fields and menus that are specific to the Humanity connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

## Prerequisites

To connect to your Humanity account and create a DataSet, you must have the following:

* A Humanity username and password.
* The API key for your Humanity account. You can find this by logging into your Humanity account and navigating to
  **Admin > Data API**.

## Connecting to Your Humanity Account

This section enumerates the options in the **Credentials** and **Details** panes in the Humanity Connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

### Credentials Pane

This pane contains fields for entering credentials to connect to your Humanity account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:201;a"><thead><tr><th colspan="1" rowspan="1"><p> Field </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Username </p></td><td colspan="1" rowspan="1"><p> Enter your Humanity username. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Password </p></td><td colspan="1" rowspan="1"><p> Enter your Humanity password. </p></td></tr><tr><td colspan="1" rowspan="1"> API Key </td><td colspan="1" rowspan="1"> Enter the API key for your Humanity account. For information about obtaining an API key, see "Prerequisites," above. </td></tr></tbody></table>

Once you have entered valid Humanity credentials, you can use the same account any time you go to create a new Humanity DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054 "Managing User Accounts for Connectors").

### Details Pane

This pane contains a primary **Report** menu in which you select a report category and an **Action** menu in which you select a specific report within that category. For example, if you selected **Admin** in the **Report** menu, you could then select **Backups**, **Files**, or **Settings** in the **Action** menu as your specific report. Depending on the options you select in these menus, other options may be available.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:201;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report/Action </p></td><td colspan="1" rowspan="1"><p> Select a Humanity report category and report within that category. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"> Admin > Backups </td><td colspan="1" rowspan="1"> Returns a list of all Backups uploaded into Humanity. </td></tr><tr><td colspan="1" rowspan="1"> Admin > Files </td><td colspan="1" rowspan="1"> Returns a list of all files uploaded into Humanity. </td></tr><tr><td colspan="1" rowspan="1"> Admin > Settings </td><td colspan="1" rowspan="1"> Returns a list of all modules, methods, and their support variables and types. </td></tr><tr><td colspan="1" rowspan="1"> Dashboard > Notifications </td><td colspan="1" rowspan="1"> Returns a list of notifications. </td></tr><tr><td colspan="1" rowspan="1"> Dashboard > On Now </td><td colspan="1" rowspan="1"> Returns a list of currently clocked-in employees. </td></tr><tr><td colspan="1" rowspan="1"> Messaging > Messages </td><td colspan="1" rowspan="1"> Returns a list of all user messages. </td></tr><tr><td colspan="1" rowspan="1"> Messaging > Wall </td><td colspan="1" rowspan="1"> Returns wall messages and comments. </td></tr><tr><td colspan="1" rowspan="1"> Payroll > Report </td><td colspan="1" rowspan="1"> Returns payroll reports on schedule/time sheet data. </td></tr><tr><td colspan="1" rowspan="1"> Schedule > Conflicts </td><td colspan="1" rowspan="1"> Returns a list of schedule conflicts. </td></tr><tr><td colspan="1" rowspan="1"> Schedule > Schedules </td><td colspan="1" rowspan="1"> Returns a list of all schedules. </td></tr><tr><td colspan="1" rowspan="1"> Schedule > Shifts </td><td colspan="1" rowspan="1"> Returns a list of shifts. </td></tr><tr><td colspan="1" rowspan="1"> Schedule > Vacations </td><td colspan="1" rowspan="1"> Returns a list of vacations. </td></tr><tr><td colspan="1" rowspan="1"> Staff > Employees </td><td colspan="1" rowspan="1"> Returns a list of all employees. </td></tr><tr><td colspan="1" rowspan="1"> Staff > Skills </td><td colspan="1" rowspan="1"> Returns a list of all skills. </td></tr><tr><td colspan="1" rowspan="1"> Timeclock > Timeclocks </td><td colspan="1" rowspan="1"> Returns a list of all Timeclocks. </td></tr><tr><td colspan="1" rowspan="1"> Timeclock > Timesheets </td><td colspan="1" rowspan="1"> Returns a list of all Timesheets. </td></tr></tbody></table></td></tr></tbody></table>

### Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").
