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

# CATS

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

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

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

[56 actions](#actions) · [24 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/cats/guides/connector-profile/api-key.md)
>
> CATS uses a static API key sent as a Token in the Authorization header.

Optionally, configure receiving Events for CATS into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/cats/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/cats/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

56 actions

ActionDescription

List Activities`cats_list_activities`

List all activities in CATS.

Get Activity`cats_get_activity`

Retrieve a single activity by ID.

Update Activity`cats_update_activity`

Update an existing activity by ID.

Delete Activity`cats_delete_activity`

Delete an activity by ID.

Search Activities`cats_search_activities`

Search activities by a text query.

Filter Activities`cats_filter_activities`

Filter activities by a specific field and value.

List Candidates`cats_list_candidates`

List all candidates in CATS.

Get Candidate`cats_get_candidate`

Retrieve a single candidate by ID.

Create Candidate`cats_create_candidate`

Create a new candidate in CATS.

Update Candidate`cats_update_candidate`

Update an existing candidate by ID.

Delete Candidate`cats_delete_candidate`

Delete a candidate by ID.

List Candidate Pipelines`cats_list_candidate_pipelines`

List all pipelines (job applications) for a candidate.

List Candidate Tasks`cats_list_candidate_tasks`

List all tasks associated with a candidate.

Search Candidates`cats_search_candidates`

Search candidates by a text query.

Filter Candidates`cats_filter_candidates`

Filter candidates by a specific field and value.

List Companies`cats_list_companies`

List all companies in CATS.

Get Company`cats_get_company`

Retrieve a single company by ID.

Create Company`cats_create_company`

Create a new company in CATS.

Update Company`cats_update_company`

Update an existing company by ID.

Delete Company`cats_delete_company`

Delete a company by ID.

List Company Tasks`cats_list_company_tasks`

List all tasks associated with a company.

Search Companies`cats_search_companies`

Search companies by a text query.

Filter Companies`cats_filter_companies`

Filter companies by a specific field and value.

List Contacts`cats_list_contacts`

List all contacts in CATS.

Get Contact`cats_get_contact`

Retrieve a single contact by ID.

Create Contact`cats_create_contact`

Create a new contact in CATS.

Update Contact`cats_update_contact`

Update an existing contact by ID.

Delete Contact`cats_delete_contact`

Delete a contact by ID.

List Contact Tasks`cats_list_contact_tasks`

List all tasks associated with a contact.

Search Contacts`cats_search_contacts`

Search contacts by a text query.

Filter Contacts`cats_filter_contacts`

Filter contacts by a specific field and value.

List Company Departments`cats_list_company_departments`

List all departments for a company in CATS.

Get Company Department`cats_get_company_department`

Retrieve a single department by ID.

Create Company Department`cats_create_company_department`

Add a new department to a company in CATS.

Update Company Department`cats_update_company_department`

Update a department's name in CATS.

Delete Company Department`cats_delete_company_department`

Delete a department from CATS.

List Jobs`cats_list_jobs`

List all job orders in CATS.

Get Job`cats_get_job`

Retrieve a single job order by ID.

Create Job`cats_create_job`

Create a new job order in CATS.

Update Job`cats_update_job`

Update an existing job order by ID.

Delete Job`cats_delete_job`

Delete a job order by ID.

List Job Pipelines`cats_list_job_pipelines`

List all pipelines (applications) for a job.

List Job Tasks`cats_list_job_tasks`

List all tasks associated with a job order.

Search Jobs`cats_search_jobs`

Search job orders by a text query.

Filter Jobs`cats_filter_jobs`

Filter job orders by a specific field and value.

List Pipelines`cats_list_pipelines`

List all pipelines (candidate-job applications) in CATS.

Get Pipeline`cats_get_pipeline`

Retrieve a single pipeline by ID.

Create Pipeline`cats_create_pipeline`

Create a new pipeline linking a candidate to a job.

Update Pipeline`cats_update_pipeline`

Update an existing pipeline by ID.

Delete Pipeline`cats_delete_pipeline`

Delete a pipeline by ID.

Filter Pipelines`cats_filter_pipelines`

Filter pipelines by a specific field and value.

List Tasks`cats_list_tasks`

List all tasks in CATS.

Get Task`cats_get_task`

Retrieve a single task by ID.

Create Task`cats_create_task`

Create a new task in CATS.

List Users`cats_list_users`

List all CATS users in the account.

Get User`cats_get_user`

Retrieve a single CATS user by ID.

## Events

Tags

Select all
|
Clear

Activities

Candidates

Companies

Contacts

Jobs

Pipelines

Users

Webhooks

No tags found

24 events

EventDescriptionTags

Candidate Created Webhook`cats_webhook_candidate_created`

Processes CATS candidate.created events, fired when a candidate is created in CATS.

CandidatesWebhooks

Job Created Webhook`cats_webhook_job_created`

Processes CATS job.created events, fired when a job order is created in CATS.

JobsWebhooks

Contact Created Webhook`cats_webhook_contact_created`

Processes CATS contact.created events, fired when a contact is created in CATS.

ContactsWebhooks

Company Created Webhook`cats_webhook_company_created`

Processes CATS company.created events, fired when a company is created in CATS.

CompaniesWebhooks

Activity Created Webhook`cats_webhook_activity_created`

Processes CATS activity.created events, fired when an activity is logged against a record in CATS.

ActivitiesWebhooks

User Created Webhook`cats_webhook_user_created`

Processes CATS user.created events, fired when a user is created in CATS.

UsersWebhooks

Pipeline Created Webhook`cats_webhook_pipeline_created`

Processes CATS pipeline.created events, fired when a candidate is added to a job order's pipeline.

PipelinesWebhooks

Candidate Updated Webhook`cats_webhook_candidate_updated`

Processes CATS candidate.updated events, fired when a candidate record is modified in CATS.

CandidatesWebhooks

Job Updated Webhook`cats_webhook_job_updated`

Processes CATS job.updated events, fired when a job order is modified in CATS.

JobsWebhooks

Contact Updated Webhook`cats_webhook_contact_updated`

Processes CATS contact.updated events, fired when a contact record is modified in CATS.

ContactsWebhooks

Company Updated Webhook`cats_webhook_company_updated`

Processes CATS company.updated events, fired when a company record is modified in CATS.

CompaniesWebhooks

Activity Updated Webhook`cats_webhook_activity_updated`

Processes CATS activity.updated events, fired when an activity record is modified in CATS.

ActivitiesWebhooks

User Updated Webhook`cats_webhook_user_updated`

Processes CATS user.updated events, fired when a user record is modified in CATS.

UsersWebhooks

Candidate Deleted Webhook`cats_webhook_candidate_deleted`

Processes CATS candidate.deleted events, fired when a candidate is deleted in CATS.

CandidatesWebhooks

Job Deleted Webhook`cats_webhook_job_deleted`

Processes CATS job.deleted events, fired when a job order is deleted in CATS.

JobsWebhooks

Contact Deleted Webhook`cats_webhook_contact_deleted`

Processes CATS contact.deleted events, fired when a contact is deleted in CATS.

ContactsWebhooks

Company Deleted Webhook`cats_webhook_company_deleted`

Processes CATS company.deleted events, fired when a company is deleted in CATS.

CompaniesWebhooks

Activity Deleted Webhook`cats_webhook_activity_deleted`

Processes CATS activity.deleted events, fired when an activity is deleted in CATS.

ActivitiesWebhooks

User Deleted Webhook`cats_webhook_user_deleted`

Processes CATS user.deleted events, fired when a user is deleted in CATS.

UsersWebhooks

Pipeline Deleted Webhook`cats_webhook_pipeline_deleted`

Processes CATS pipeline.deleted events, fired when a candidate is removed from a job order's pipeline.

PipelinesWebhooks

Job Status Changed Webhook`cats_webhook_job_status_changed`

Processes CATS job.status\_changed events, fired when the status of a job order changes. The payload carries the previous...

JobsWebhooks

Contact Status Changed Webhook`cats_webhook_contact_status_changed`

Processes CATS contact.status\_changed events, fired when a contact's status changes. The payload carries the previous an...

ContactsWebhooks

Company Status Changed Webhook`cats_webhook_company_status_changed`

Processes CATS company.status\_changed events, fired when a company's status changes. The payload carries the previous an...

CompaniesWebhooks

Pipeline Status Changed Webhook`cats_webhook_pipeline_status_changed`

Processes CATS pipeline.status\_changed events, fired when a candidate moves to a different status in a job order's pipel...

PipelinesWebhooks


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