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

# Clockwork Recruiting

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

![Clockwork Recruiting](https://stackone-logos.com/api/clockwork/filled/svg)

Betav1.2.0[See changelog](https://docs.stackone.com/connectors/clockwork/changelog.md)

[16 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/clockwork/guides/connector-profile/api-key.md)
>
> Requires four credentials — API Key, API Secret, Firm Service Key, and your Firm Name (the subdomain in the API base pat...

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

16 actions

ActionDescription

List People`clockwork_list_people`

List the firm's people — candidates and contacts — with optional LinkedIn URL filter and sorting.

Get Person`clockwork_get_person`

Get a single person by ID, optionally embedding their preferred contact details, position and tags.

Create Person`clockwork_create_person`

Create a person (candidate or contact) in the firm, optionally tagging them and setting custom field values.

Update Person`clockwork_update_person`

Update a person's core record — name, biography, flags, tags, and which of their contact records are preferred.

Delete Person`clockwork_delete_person`

Delete a person from the firm by ID.

Search People`clockwork_search_people`

Full-text search across the firm's people, with filters for date added, LinkedIn URL, and specific person IDs.

List Projects`clockwork_list_projects`

List the firm's search projects, optionally filtered by status, project type, or assigned user.

Search Projects`clockwork_search_projects`

Find projects by their client company — fuzzy name, company ID, or company LinkedIn URL.

Get Project`clockwork_get_project`

Get a single search project by ID, optionally embedding client company, lead, owner and placement details.

List Candidacies`clockwork_list_candidacies`

List the candidacies on a search project — the people being considered for that role.

Get Candidacy`clockwork_get_candidacy`

Get a single candidacy on a project by ID, optionally embedding the person, project and its notes.

Create Candidacy`clockwork_create_candidacy`

Add a person to a search project as a candidate.

Update Candidacy`clockwork_update_candidacy`

Update a candidacy on a project — move its pipeline stage, reassign the recruiter, or change its flags.

Delete Candidacy`clockwork_delete_candidacy`

Delete a candidacy from a project. Only candidacies with no notes attached can be deleted.

List Companies`clockwork_list_companies`

List the firm's companies, optionally filtered by name, do-not-contact flag, or client-company status.

Get Company`clockwork_get_company`

Get a single company by ID, optionally embedding its tags and logo.


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