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

# Mercury

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

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

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

[47 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] [API Key · Connector Profile](https://docs.stackone.com/connectors/mercury/guides/connector-profile/api-key.md)
>
> Uses static subscription-key + tenant-id headers issued by Mercury via Azure API Management. Requires per-customer onboa...

**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/mercury/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

47 actions

ActionDescription

List Activity Purposes`mercury_get_all_activity_purposes`

Retrieve tenant-configured activity purposes (categories).

List Activities For A Contact`mercury_get_activities_by_contact`

Retrieve all activities logged against a Mercury contact.

Create Activity On A Contact`mercury_create_contact_activity`

Log a new CRM activity (email, phone call, task, appointment, or update) against a contact.

List Contact Annotations`mercury_get_annotations_by_contact`

Retrieve all annotations (notes) on a Mercury contact.

Create Annotation On A Contact`mercury_create_contact_annotation`

Create a note against a Mercury contact.

Get Candidate Company By ID`mercury_get_candidate_company`

Retrieve a candidate company (candidate's employing company) by Id.

Get Candidate By ID`mercury_get_candidate`

Retrieve a candidate (contact with isCandidateContact=true) by Id.

List Placements For A Candidate`mercury_get_placements_by_candidate`

Retrieve all placements a candidate has been involved in.

Upload Document To A Candidate`mercury_upload_candidate_document`

Upload a document (max 5MB) against a candidate.

Upload CV To Create New Candidate (parse)`mercury_cv_parse_create_candidate`

Upload a CV to create a new candidate via Mercury's CV parsing engine.

Upload CV To Update Existing Candidate (parse)`mercury_cv_parse_update_candidate`

Upload a CV to update an existing candidate via Mercury's CV parsing engine.

List Clients`mercury_get_all_clients`

Retrieve all clients (hiring organisations) in the Mercury tenant.

Get Client By ID`mercury_get_client`

Retrieve a single Mercury client by Id.

Create Client`mercury_create_client`

Create a new client (hiring organisation) in Mercury.

Patch Client`mercury_patch_client`

Partially update a Mercury client.

Create Compliance Record On A Placement`mercury_create_placement_compliance`

Create a compliance / vetting record attached to a Mercury placement.

List Compliance Records For A Placement`mercury_get_compliance_by_placement`

Retrieve all compliance records attached to a placement.

Get Compliance Record By ID`mercury_get_compliance`

Retrieve a compliance record by Id (includes base64 evidence file if present).

Patch Compliance Record`mercury_patch_compliance`

Partially update a compliance record.

Upload Evidence To A Compliance Record`mercury_upload_compliance_evidence`

Upload an evidence document to a compliance record.

List Contacts`mercury_get_all_contacts`

Retrieve Mercury contacts (candidate contacts, client contacts, or both), paginated.

Get Contact By ID`mercury_get_contact`

Retrieve a single Mercury contact by Id.

Create Contact`mercury_create_contact`

Create a new Mercury contact (candidate, client contact, or both).

Patch Contact`mercury_patch_contact`

Partially update a Mercury contact.

Upload CV To A Contact`mercury_upload_contact_cv`

Upload a CV document against a Mercury contact.

Get Primary CV For A Contact`mercury_get_contact_cv`

Retrieve the primary CV document for a Mercury contact (base64-encoded content).

Upload Document To A Contact`mercury_upload_contact_document`

Upload a non-CV document against a Mercury contact.

List Contact Files (SharePoint)`mercury_get_file_details_by_contact`

List all SharePoint files associated with a Mercury contact.

Get File Content By Path`mercury_get_file_content`

Retrieve a document's content (base64) by SharePoint path.

List Contact Education`mercury_get_all_contact_education`

Retrieve contact education records across the tenant with pagination.

List Placements`mercury_get_all_placements`

Retrieve Mercury placements with pagination and filters.

Get Placement By ID`mercury_get_placement`

Retrieve a Mercury placement by Id.

List Finance Rates For A Placement`mercury_get_finance_rates_by_placement`

Retrieve pay/charge finance rates attached to a placement.

List All Placement Fees`mercury_get_all_placement_fees`

Retrieve placement fees across all placements on the tenant with pagination.

List Fees For A Placement`mercury_get_placement_fees_by_placement`

Retrieve all fees attached to a single placement.

List Contact Skills`mercury_get_all_contact_skills`

Retrieve contact skill records across the tenant with pagination.

Patch Skill Level`mercury_patch_skill_level`

Update level, experience, or proficiency on a contact skill record.

List System Users`mercury_get_all_users`

Retrieve all Mercury system users (recruitment consultants and staff members).

Get System User By ID`mercury_get_user`

Retrieve a single Mercury system user by Id.

List Vacancies`mercury_get_all_vacancies`

Retrieve Mercury vacancies (open positions) with pagination and filters.

Get Vacancy By ID`mercury_get_vacancy`

Retrieve a Mercury vacancy by Id.

Create Vacancies (batch)`mercury_create_vacancies_batch`

Create a batch of vacancies in Mercury.

Update Vacancies (batch)`mercury_update_vacancies_batch`

Fully update a batch of vacancies in Mercury.

Patch Vacancies (batch)`mercury_patch_vacancies_batch`

Partially update a batch of vacancies in Mercury.

List Shortlists For A Vacancy`mercury_get_shortlists_by_vacancy`

Retrieve the candidate shortlist for a Mercury vacancy.

List Contact Work History`mercury_get_all_contact_work_history`

Retrieve contact work history records across the tenant with pagination.

Patch Work History Entry`mercury_patch_work_history`

Update a contact work history entry.


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