> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PrismHR

> How to set up the PrismHR connector, plus the actions that are available.

![PrismHR](https://stackone-logos.com/api/prismhr/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/prismhr/changelog.md)

[30 actions](#actions) · 1 auth method

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Web Service User · Connector Profile](https://docs.stackone.com/connectors/prismhr/guides/connector-profile/web-service-user.md)
>
> Session-based token authentication using PrismHR Web Service User credentials. Provide your Web Service User ID, passwor...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Web Service User · Link Account](https://docs.stackone.com/connectors/prismhr/guides/link-account/web-service-user.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

30 actions

ActionDescription

Get Employee List`prismhr_get_employee_list`

Retrieve a list of employee IDs for a specific client company

Get Employee`prismhr_get_employee`

Retrieve detailed information for one or more employees by their IDs

Update Employee Fields`prismhr_update_employee_fields`

Update individual fields on an employee record without requiring a checksum

Update Address Info`prismhr_update_address_info`

Update an employee's home address, W-2 address, and alternate address

Update Employee Status Type`prismhr_update_employee_status_type`

Change an employee's employment status and/or type

Terminate Employee`prismhr_terminate_employee`

Terminate an employee's employment

Rehire Employee`prismhr_rehire_employee`

Rehire a previously terminated employee

Get History`prismhr_get_history`

Retrieve pay rate changes, position changes, leaves, and status changes for an employee

Get Employee Events`prismhr_get_employee_events`

Retrieve events for a specific employee

Get User Defined Fields`prismhr_get_user_defined_fields`

Retrieve user-defined custom field definitions and values

Get Client List`prismhr_get_client_list`

Retrieve a list of all client/company IDs, names, and statuses

Get Client Master`prismhr_get_client_master`

Retrieve detailed information for a specific client/company

Create Client Master`prismhr_create_client_master`

Create a new client/company record in PrismHR

Get All Prism Client Contacts`prismhr_get_all_prism_client_contacts`

Retrieve all contacts for a specified client/company

Get Client Location Details`prismhr_get_client_location_details`

Retrieve worksite location details for a client/company

Set Client Location Details`prismhr_set_client_location_details`

Create or update a worksite location for a client/company

Get Employee List By Entity`prismhr_get_employee_list_by_entity`

Retrieve employee lists grouped by organizational entity for a client

Get Active Benefit Plans`prismhr_get_active_benefit_plans`

Retrieve active benefit plan enrollment information for an employee

Get Group Benefit Plan`prismhr_get_group_benefit_plan`

Retrieve details for a specific group benefit plan

Get Dependents`prismhr_get_dependents`

Retrieve dependent information for a specified employee

Get Retirement Plan List`prismhr_get_retirement_plan_list`

Retrieve retirement benefit plans for a client

Get Paid Time Off`prismhr_get_paid_time_off`

Retrieve employee PTO register/balance information

Get PTO Requests List`prismhr_get_pto_requests_list`

Retrieve PTO/leave requests for employees in a client

Request PTO`prismhr_request_pto`

Create a planned time off request for an employee

Approve Or Deny PTO Request`prismhr_approve_or_deny_pto_request`

Approve, deny, or cancel an employee PTO request

Get Batch List By Date`prismhr_get_batch_list_by_date`

Retrieve payroll batch list by date range for a client

Get Batch Info`prismhr_get_batch_info`

Retrieve detailed information for a specific payroll batch

Get Pay Group Details`prismhr_get_pay_group_details`

Retrieve pay group details for a client

Get Payroll Schedule`prismhr_get_payroll_schedule`

Retrieve pay group and pay schedule information for a client

Get Employer Details`prismhr_get_employer_details`

Retrieve data for all employers in the system or a specific employer


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.