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

# SearchOS

> How to set up the SearchOS connector, plus the actions and events that are available.

![SearchOS](data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20viewBox%3D%220%200%2024%2024%22%3E%3Crect%20width%3D%2224%22%20height%3D%2224%22%20rx%3D%228%22%20fill%3D%22%23D5D4D2%22%2F%3E%3Crect%20x%3D%228%22%20y%3D%228%22%20width%3D%228%22%20height%3D%228%22%20rx%3D%222.667%22%20fill%3D%22%23A19F9E%22%2F%3E%3C%2Fsvg%3E)

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

[27 actions](#actions) · [4 events](#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](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/searchos/guides/connector-profile/api-key.md)
>
> 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.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/searchos/guides/webhook-setup.md)

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

27 actions

ActionDescription

List Campaigns`searchos_list_campaigns`

List outreach campaigns in the SearchOS workspace

Get Campaign`searchos_get_campaign`

Get a campaign by ID

List Candidates`searchos_list_candidates`

List candidates in the SearchOS workspace

Get Candidate`searchos_get_candidate`

Get a candidate by ID

Create Candidate`searchos_create_candidate`

Create a candidate from structured profile data

Create Candidate From CV`searchos_create_candidate_from_cv`

Create a candidate by uploading a CV for SearchOS to parse

Update Candidate`searchos_update_candidate`

Update fields on a candidate

Delete Candidate`searchos_delete_candidate`

Delete a candidate permanently

List Candidate Files`searchos_list_candidate_files`

List files attached to a candidate

Upload Candidate File`searchos_upload_candidate_file`

Attach a file to a candidate

List Companies`searchos_list_companies`

List client companies in the SearchOS workspace

Get Company`searchos_get_company`

Get a company by ID

Create Company`searchos_create_company`

Create a client company

Update Company`searchos_update_company`

Update fields on a company

Delete Company`searchos_delete_company`

Delete a company permanently

List Company Files`searchos_list_company_files`

List files attached to a company

Upload Company File`searchos_upload_company_file`

Attach a file to a company

List Contacts`searchos_list_contacts`

List client contacts in the SearchOS workspace

Bulk Create Contacts`searchos_bulk_create_contacts`

Create up to 500 contacts in one request

List Contact Files`searchos_list_contact_files`

List files attached to a contact

Upload Contact File`searchos_upload_contact_file`

Attach a file to a contact

List Vacancies`searchos_list_vacancies`

List vacancies in the SearchOS workspace

List Vacancy Pipeline`searchos_list_vacancy_pipeline`

List the candidates in a vacancy's pipeline

Add Vacancy Pipeline Candidates`searchos_add_vacancy_pipeline_candidates`

Add one or more candidates to a vacancy's pipeline

Update Vacancy Pipeline`searchos_update_vacancy_pipeline`

Move a candidate to another stage in a vacancy's pipeline

List Vacancy Files`searchos_list_vacancy_files`

List files attached to a vacancy

Upload Vacancy File`searchos_upload_vacancy_file`

Attach a file to a vacancy

## Events

Tags

Select all
|
Clear

Applications

Candidates

Offers

Placements

No tags found

4 events

EventDescriptionTags

Candidate Created`searchos_webhook_candidate_created`

Processes SearchOS candidate.created events, sent when a candidate is added.

Candidates

Application Received`searchos_webhook_application_received`

Processes SearchOS application.received events, sent when someone applies on a careers page.

Applications

Offer Accepted`searchos_webhook_offer_accepted`

Processes SearchOS offer.accepted events, sent when a candidate's offer is marked accepted.

Offers

Placement Made`searchos_webhook_placement_made`

Processes SearchOS placement.made events, sent when a candidate reaches the Placed stage.

Placements


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