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

# Eploy

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

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

Previewv2.0.0[See changelog](https://docs.stackone.com/connectors/eploy/changelog.md)

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

ATS

## 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] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/eploy/guides/connector-profile/oauth-2-0.md)
>
> The steps in this guide require Administrator privileges within Eploy.

**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] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/eploy/guides/link-account/oauth-2-0.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

Scopes

Select all
|
Clear

actions.insert

actions.read

actions.update

applications.insert

applications.read

applications.update

candidates.insert

candidates.read

candidates.update

companies.insert

companies.read

companies.update

contacts.insert

contacts.read

contacts.update

files.read

notes.insert

notes.read

notes.update

payrates.read

paysalaries.read

placements.insert

placements.read

placements.update

timesheets.delete

timesheets.insert

timesheets.read

timesheets.update

users.insert

users.read

users.update

vacancies.insert

vacancies.read

vacancies.update

vacancytemplates.read

No scopes found

92 actions

ActionDescriptionRequired scopes

Search Activities`eploy_search_activities`

Search for activities/actions with pagination and filtering support using Eploy search API

`actions.read`

Get Activity`eploy_get_activity`

Retrieve activity details by action ID

`actions.read`

Create Activity`eploy_create_activity`

Create a new activity/action

`actions.insert`

Update Activity`eploy_update_activity`

Update an existing activity by action ID

`actions.update`

Search Candidates`eploy_search_candidates`

Search for candidates with pagination and filtering support

`candidates.read`

Get Candidate`eploy_get_candidate`

Retrieve a single candidate by ID

`candidates.read`

Create Candidate`eploy_create_candidate`

Create a new candidate record

`candidates.insert`

Update Candidate`eploy_update_candidate`

Update an existing candidate record

`candidates.update`

Get Candidate Addresses`eploy_get_candidate_addresses`

Retrieve all addresses for a candidate

`candidates.read`

Add Candidate Address`eploy_add_candidate_address`

Add a new address for a candidate

`candidates.update`

Update Candidate Address`eploy_update_candidate_address`

Update an existing address for a candidate

`candidates.update`

Delete Candidate Address`eploy_delete_candidate_address`

Delete an address from a candidate

`candidates.update`

Get Candidate Bank Details`eploy_get_candidate_bank_details`

Retrieve bank details for a candidate

`candidates.read`

Update Candidate Bank Details`eploy_update_candidate_bank_details`

Update bank details for a candidate

`candidates.update`

Get Candidate Employment History`eploy_get_candidate_employment`

Retrieve employment history for a candidate

`candidates.read`

Add Candidate Employment`eploy_add_candidate_employment`

Add employment history record for a candidate

`candidates.update`

Update Candidate Employment`eploy_update_candidate_employment`

Update an employment history record for a candidate

`candidates.update`

Delete Candidate Employment`eploy_delete_candidate_employment`

Delete an employment history record.

`candidates.update`

Get Candidate Questions`eploy_get_candidate_questions`

Retrieve question answers for a candidate

`candidates.read`

Set Candidate Questions`eploy_set_candidate_questions`

Set question answers for a candidate

`candidates.update`

Get Candidate Questions List`eploy_get_candidate_questions_list`

Retrieve all available questions for candidates

`candidates.read`

Get CV Upload Types`eploy_get_cv_upload_types`

Retrieve supported CV file types

`candidates.read`

Get File Upload Types`eploy_get_file_upload_types`

Retrieve supported file types for candidate uploads

`candidates.read`

Upload Candidate CV`eploy_upload_candidate_cv`

Upload a CV file to a candidate. Accepted formats for FileTypeId=2 (CV) are doc, docx, pdf, txt, rtf, wps, odt — other f...

`candidates.update`

Upload Candidate File`eploy_upload_candidate_file`

Upload a general file to a candidate

`candidates.update`

Search Companies`eploy_search_companies`

Search for companies with pagination and filtering support using Eploy search API

`companies.read`

Get Company`eploy_get_company`

Retrieve company details by company ID

`companies.read`

Create Company`eploy_create_company`

Create a new company

`companies.insert`

Update Company`eploy_update_company`

Update an existing company by company ID

`companies.update`

Get Company Questions List`eploy_get_company_questions_list`

Retrieve all available questions for companies

`companies.read`

Get Company Questions`eploy_get_company_questions`

Retrieve questions and answers for a specific company

`companies.read`

Set Company Questions`eploy_set_company_questions`

Set question answers for a company

`companies.update`

Search Applications`eploy_search_applications`

Search for applications with pagination and filtering support using Eploy search API

`applications.read`

Get Application`eploy_get_application`

Retrieve application details by application ID

`applications.read`

Create Application`eploy_create_application`

Create a new application for a candidate applying to a vacancy

`applications.insert`

Update Application`eploy_update_application`

Update an existing application by application ID

`applications.update`

Get Application Questions List`eploy_get_application_questions_list`

Retrieve all available questions for applications

`applications.read`

Get Application Questions`eploy_get_application_questions`

Retrieve questions and answers for a specific application

`applications.read`

Set Application Questions`eploy_set_application_questions`

Set questions and answers for a specific application

`applications.update`

Get Application Status History`eploy_get_application_status_history`

Retrieve status history for a specific application

`applications.read`

Search Application Status History`eploy_search_application_status_history`

Search for application status history with pagination and filtering

`applications.read`

Upload Application File`eploy_upload_application_file`

Upload a file to an application

`applications.update`

Get Application File Upload Types`eploy_get_application_file_upload_types`

Retrieve supported file upload types for applications

`applications.read`

Search Vacancies`eploy_search_vacancies`

Search for vacancies with pagination and filtering support using Eploy search API

`vacancies.read`

Get Vacancy`eploy_get_vacancy`

Retrieve vacancy details by vacancy ID

`vacancies.read`

Create Vacancy`eploy_create_vacancy`

Create a new vacancy/job posting

`vacancies.insert`

Update Vacancy`eploy_update_vacancy`

Update an existing vacancy by vacancy ID

`vacancies.update`

Get Vacancy Questions List`eploy_get_vacancy_questions_list`

Retrieve all available questions for vacancies

`vacancies.read`

Get Vacancy Questions`eploy_get_vacancy_questions`

Retrieve questions and answers for a specific vacancy

`vacancies.read`

Search Vacancy Templates`eploy_search_vacancy_templates`

Search for vacancy templates with pagination and filtering support using Eploy search API

`vacancytemplates.read`

Get Vacancy Template`eploy_get_vacancy_template`

Retrieve vacancy template details by vacancy template ID

`vacancytemplates.read`

Search Contacts`eploy_search_contacts`

Search for contacts with pagination and filtering support using Eploy search API

`contacts.read`

Get Contact`eploy_get_contact`

Retrieve contact details by contact ID

`contacts.read`

Create Contact`eploy_create_contact`

Create a new contact

`contacts.insert`

Update Contact`eploy_update_contact`

Update an existing contact by contact ID

`contacts.update`

Get Contact Questions List`eploy_get_contact_questions_list`

Retrieve all available questions for contacts

`contacts.read`

Get Contact Questions`eploy_get_contact_questions`

Retrieve questions and answers for a specific contact

`contacts.read`

Set Contact Questions`eploy_set_contact_questions`

Set question answers for a contact

`contacts.update`

Search Users`eploy_search_users`

Search for users with pagination and filtering support using Eploy search API

`users.read`

Get User`eploy_get_user`

Retrieve user details by user ID

`users.read`

Create User`eploy_create_user`

Create a new user. Either RoleIDs or CopyPermissionsFromUserId must be provided — the provider returns 400 if neither is...

`users.insert`

Update User`eploy_update_user`

Update an existing user by user ID

`users.update`

Search Placements`eploy_search_placements`

Search for placements with pagination and filtering support using Eploy search API

`placements.read`

Get Placement`eploy_get_placement`

Retrieve placement details by placement ID

`placements.read`

Create Placement`eploy_create_placement`

Create a new placement

`placements.insert`

Update Placement`eploy_update_placement`

Update an existing placement by placement ID

`placements.update`

Get Placement Questions List`eploy_get_placement_questions_list`

Retrieve all available questions for placements

`placements.read`

Get Placement Questions`eploy_get_placement_questions`

Retrieve questions and answers for a specific placement

`placements.read`

Search Timesheets`eploy_search_timesheets`

Search for timesheets with pagination and filtering support using Eploy search API

`timesheets.read`

Get Timesheet`eploy_get_timesheet`

Retrieve timesheet details by timesheet ID

`timesheets.read`

Create Timesheet`eploy_create_timesheet`

Create a new timesheet. Only one timesheet can exist per PlacementId and WeekCommencing date; a second create for the sa...

`timesheets.insert`

Update Timesheet`eploy_update_timesheet`

Update an existing timesheet by timesheet ID

`timesheets.update`

Delete Timesheet`eploy_delete_timesheet`

Delete a timesheet by timesheet ID

`timesheets.delete`

Search Notes`eploy_search_notes`

Search for notes with pagination and filtering support using Eploy search API

`notes.read`

Get Note`eploy_get_note`

Retrieve note details by note ID

`notes.read`

Create Note`eploy_create_note`

Create a new note

`notes.insert`

Update Note`eploy_update_note`

Update an existing note by note ID

`notes.update`

List Available Options`eploy_list_options`

Retrieve available dropdown lists/lookup options in the system

Get Option Values`eploy_get_option_values`

Retrieve values for a specific dropdown list by type and reference

Search Option Values`eploy_search_option_values`

Search for option values with pagination and filtering support

Get CV Metadata`eploy_get_cv`

Get CV metadata by CV ID

`files.read`

Download CV`eploy_download_cv`

Download CV file by CV ID

`files.read`

Search CVs`eploy_search_cvs`

Search for CVs with pagination and filtering support using Eploy search API

`files.read`

Get File Metadata`eploy_get_file`

Get file metadata by file ID

`files.read`

Download File`eploy_download_file`

Download file by file ID. Returns the raw binary file content as a string in response.data (not a structured object). Th...

`files.read`

Search Files`eploy_search_files`

Search for files with pagination and filtering support using Eploy search API

`files.read`

Get Pay Rate`eploy_get_payrate`

Get pay rate details by pay rate ID

`payrates.read`

Get Pay Salary`eploy_get_paysalary`

Get pay salary details by pay salary ID

`paysalaries.read`

Get Pay Band`eploy_get_payband`

Get pay salary band details by pay band ID

`paysalaries.read`

Search Pay Salaries`eploy_search_paysalaries`

Search for pay salaries with pagination and filtering support using Eploy search API

`paysalaries.read`

Get Role Information By RoleID`eploy_get_role`

Get Role Information by RoleID

`users.read`

Search User Roles`eploy_search_role`

Search User Roles

`users.read`


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