Skip to main content
SearchOS
Previewv0.1.0
27 actions · 4 events · 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.
2

Configure the Connector

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

API Key · Connector Profile

Uses a workspace API key created in SearchOS Settings. Access is scoped to one workspace and ends when the key is revoke…
Optionally, configure receiving Events for SearchOS into StackOne.

Webhooks setup

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:

API Key · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

27 actions
Action
Description
List Campaigns
List outreach campaigns in the SearchOS workspace
Get Campaign
Get a campaign by ID
List Candidates
List candidates in the SearchOS workspace
Get Candidate
Get a candidate by ID
Create Candidate
Create a candidate from structured profile data
Create Candidate From CV
Create a candidate by uploading a CV for SearchOS to parse
Update Candidate
Update fields on a candidate
Delete Candidate
Delete a candidate permanently
List Candidate Files
List files attached to a candidate
Upload Candidate File
Attach a file to a candidate
List Companies
List client companies in the SearchOS workspace
Get Company
Get a company by ID
Create Company
Create a client company
Update Company
Update fields on a company
Delete Company
Delete a company permanently
List Company Files
List files attached to a company
Upload Company File
Attach a file to a company
List Contacts
List client contacts in the SearchOS workspace
Bulk Create Contacts
Create up to 500 contacts in one request
List Contact Files
List files attached to a contact
Upload Contact File
Attach a file to a contact
List Vacancies
List vacancies in the SearchOS workspace
List Vacancy Pipeline
List the candidates in a vacancy’s pipeline
Add Vacancy Pipeline Candidates
Add one or more candidates to a vacancy’s pipeline
Update Vacancy Pipeline
Move a candidate to another stage in a vacancy’s pipeline
List Vacancy Files
List files attached to a vacancy
Upload Vacancy File
Attach a file to a vacancy

Events

|
4 events
Event
Description
Tags
Candidate Created
Processes SearchOS candidate.created events, sent when a candidate is added.
Candidates
Application Received
Processes SearchOS application.received events, sent when someone applies on a careers page.
Applications
Offer Accepted
Processes SearchOS offer.accepted events, sent when a candidate’s offer is marked accepted.
Offers
Placement Made
Processes SearchOS placement.made events, sent when a candidate reaches the Placed stage.
Placements