Skip to main content
Mercury
v0.1.0 - latest version
47 actions · 1 auth method
PreviewATS

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

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 (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

4

Use Actions

Connect your agent to the linked account’s actions. See Agent Setup.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

47 actions
Action
Description
List Activity Purposes
Retrieve tenant-configured activity purposes (categories).
List Activities For A Contact
Retrieve all activities logged against a Mercury contact.
Create Activity On A Contact
Log a new CRM activity (email, phone call, task, appointment, or update) against a contact.
List Contact Annotations
Retrieve all annotations (notes) on a Mercury contact.
Create Annotation On A Contact
Create a note against a Mercury contact.
Get Candidate Company By ID
Retrieve a candidate company (candidate’s employing company) by Id.
Get Candidate By ID
Retrieve a candidate (contact with isCandidateContact=true) by Id.
List Placements For A Candidate
Retrieve all placements a candidate has been involved in.
Upload Document To A Candidate
Upload a document (max 5MB) against a candidate.
Upload CV To Create New Candidate (parse)
Upload a CV to create a new candidate via Mercury’s CV parsing engine.
Upload CV To Update Existing Candidate (parse)
Upload a CV to update an existing candidate via Mercury’s CV parsing engine.
List Clients
Retrieve all clients (hiring organisations) in the Mercury tenant.
Get Client By ID
Retrieve a single Mercury client by Id.
Create Client
Create a new client (hiring organisation) in Mercury.
Patch Client
Partially update a Mercury client.
Create Compliance Record On A Placement
Create a compliance / vetting record attached to a Mercury placement.
List Compliance Records For A Placement
Retrieve all compliance records attached to a placement.
Get Compliance Record By ID
Retrieve a compliance record by Id (includes base64 evidence file if present).
Patch Compliance Record
Partially update a compliance record.
Upload Evidence To A Compliance Record
Upload an evidence document to a compliance record.
List Contacts
Retrieve Mercury contacts (candidate contacts, client contacts, or both), paginated.
Get Contact By ID
Retrieve a single Mercury contact by Id.
Create Contact
Create a new Mercury contact (candidate, client contact, or both).
Patch Contact
Partially update a Mercury contact.
Upload CV To A Contact
Upload a CV document against a Mercury contact.
Get Primary CV For A Contact
Retrieve the primary CV document for a Mercury contact (base64-encoded content).
Upload Document To A Contact
Upload a non-CV document against a Mercury contact.
List Contact Files (SharePoint)
List all SharePoint files associated with a Mercury contact.
Get File Content By Path
Retrieve a document’s content (base64) by SharePoint path.
List Contact Education
Retrieve contact education records across the tenant with pagination.
List Placements
Retrieve Mercury placements with pagination and filters.
Get Placement By ID
Retrieve a Mercury placement by Id.
List Finance Rates For A Placement
Retrieve pay/charge finance rates attached to a placement.
List All Placement Fees
Retrieve placement fees across all placements on the tenant with pagination.
List Fees For A Placement
Retrieve all fees attached to a single placement.
List Contact Skills
Retrieve contact skill records across the tenant with pagination.
Patch Skill Level
Update level, experience, or proficiency on a contact skill record.
List System Users
Retrieve all Mercury system users (recruitment consultants and staff members).
Get System User By ID
Retrieve a single Mercury system user by Id.
List Vacancies
Retrieve Mercury vacancies (open positions) with pagination and filters.
Get Vacancy By ID
Retrieve a Mercury vacancy by Id.
Create Vacancies (batch)
Create a batch of vacancies in Mercury.
Update Vacancies (batch)
Fully update a batch of vacancies in Mercury.
Patch Vacancies (batch)
Partially update a batch of vacancies in Mercury.
List Shortlists For A Vacancy
Retrieve the candidate shortlist for a Mercury vacancy.
List Contact Work History
Retrieve contact work history records across the tenant with pagination.
Patch Work History Entry
Update a contact work history entry.