> ## 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.

# ClayHR

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

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

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

[50 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] [API Key · Connector Profile](https://docs.stackone.com/connectors/clayhr/guides/connector-profile/api-key.md)
>
> Authenticate using your ClayHR API Key and User ID. Generate your API key from My Integrations in the ClayHR app.

**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] [API Key · Link Account](https://docs.stackone.com/connectors/clayhr/guides/link-account/api-key.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

50 actions

ActionDescription

List Users`clayhr_list_users`

Retrieve the list of all users from ClayHR.

Create Announcement`clayhr_create_announcement`

Create a new announcement in ClayHR.

Retrieve Announcement`clayhr_get_announcement`

Retrieve a single announcement by its ID from ClayHR.

List Document Library`clayhr_list_document_library`

Retrieve attachments within the document library from ClayHR.

Download Document`clayhr_get_document_bytes`

Retrieve a document as a byte array by file ID from ClayHR.

Save Custom Field Values`clayhr_save_user_custom_fields`

Save custom field values for a user in ClayHR.

List Currencies`clayhr_list_currencies`

Retrieve the list of available currencies supported by the system.

List Expense Reports`clayhr_list_expense_reports`

Retrieve expense reports for a user, filterable by user ID, GUID, or email.

Get Expense Report Details`clayhr_get_expense_report`

Retrieve detailed information for a single expense report by ID or GUID.

List Expense Types`clayhr_list_expense_types`

Retrieve the list of expense types available in the system.

Create Expense Report`clayhr_create_expense_report`

Create a new expense report for a user.

Create Expense Item`clayhr_create_expense_item`

Create a new expense item and attach it to an expense report.

Delete Expense Item`clayhr_delete_expense_item`

Delete an expense item by its ID.

Delete Expense Report`clayhr_delete_expense_report`

Delete an expense report by its ID.

Retrieve Form Details`clayhr_get_form_details`

Retrieve the structure and metadata of a dynamic form (non-survey, non-test) by its form ID.

Retrieve Form Responses`clayhr_list_form_responses`

Retrieve the list of responses submitted for a specific form.

Retrieve Forms`clayhr_list_forms`

Retrieve all dynamic form templates configured organization-wide in ClayHR.

Retrieve Completed Forms Assigned To The Authenticated User`clayhr_list_completed_forms`

Retrieve forms that the authenticated user has already completed and submitted.

Save A Form Response`clayhr_create_form_response`

Save a completed dynamic form response (non-survey) for a specific form assignment.

Save A Form Item Response`clayhr_create_form_item_response`

Save an answer for a single field within a dynamic form (non-survey) assignment.

Create Goal`clayhr_create_goal`

Create a new goal in ClayHR.

Create A New Leave Request`clayhr_create_leave_request`

Create a new leave request in ClayHR.

Get PTO Policies By User ID`clayhr_list_pto_policies_by_user`

Retrieve only the PTO policies specifically assigned to the currently authenticated user, not the full organization list...

Get Remaining Hours Credit For A Leave Policy`clayhr_get_leave_hours_credit`

Retrieve the remaining hours credit for a specific leave policy and user.

Process A User's Leave By Leave ID And Status`clayhr_process_leave`

Process a leave request by updating its status (e.g. approved, rejected, pending).

Delete User Address`clayhr_delete_user_address`

Deletes a specific address record for a user in ClayHR.

Delete User Education`clayhr_delete_user_education`

Deletes a specific education record for a user in ClayHR.

Delete User Employment`clayhr_delete_user_employment`

Deletes a specific employment record for a user in ClayHR.

Retrieve Performance Review Assignments For A User`clayhr_list_performance_review_assignments`

Retrieve pending performance review assignments (reviews you need to complete as a reviewer) for the authenticated user.

List Performance Reviews`clayhr_list_performance_reviews`

Retrieve all performance reviews (including in-progress) for the authenticated user.

Create Performance Review`clayhr_create_performance_review`

Create a new performance review for a specified user in ClayHR.

List Completed Performance Reviews`clayhr_list_completed_performance_reviews`

Retrieve only completed/finalized performance reviews for a specific user by their user ID.

List Performance Review Templates`clayhr_list_performance_review_templates`

Retrieve all available performance review templates from ClayHR.

Create Bulk Performance Reviews`clayhr_create_bulk_performance_reviews`

Launch performance reviews in bulk for multiple users in ClayHR.

List Projects`clayhr_list_projects`

Retrieve the list of all projects from ClayHR.

Get Project Details By Project ID`clayhr_get_project`

Retrieve detailed information for a specific project by its ID from ClayHR.

Create A Project`clayhr_create_project`

Create a new project in ClayHR.

Save Project Allocation By Project ID`clayhr_create_project_allocation`

Create a project allocation to assign a user to a project in ClayHR.

Create Skill`clayhr_create_skill`

Create a new skill in ClayHR.

Get Survey Details`clayhr_get_survey_details`

Retrieve the structure and configuration of a survey-type form by its form ID.

Create Survey Response`clayhr_create_survey_response`

Create a survey-type form response for a specific survey assignment in ClayHR.

Create Survey Item Response`clayhr_create_survey_item_response`

Save an answer for a single question within a survey assignment in ClayHR.

List Assigned Tests`clayhr_list_assigned_tests`

Retrieve the list of tests assigned to a user in ClayHR.

Get Test Details`clayhr_get_test_details`

Retrieve the configuration and questions of a test/quiz by its dynamic form ID.

Clock In`clayhr_clock_in`

Clock in an employee on the timesheet in ClayHR.

Clock Out`clayhr_clock_out`

Clock out an employee on the timesheet in ClayHR.

List Timesheet Approvals`clayhr_list_timesheet_approvals`

Retrieve a list of timesheet approvals from ClayHR.

Update Timesheet Status`clayhr_update_timesheet_status`

Update the status of a timesheet in ClayHR.

Get Training Content`clayhr_get_training_content`

Retrieve training content by training ID from ClayHR.

List PTO Policies`clayhr_list_pto_policies`

Retrieve all PTO policies configured organization-wide in ClayHR.


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