CATS MCP by usefulapi

The CATS site (account) this API key belongs to: id, mode (recruiter or employer) and subdomain. GET /site.

Takes no parameters.

List the CATS users (recruiters) with id, name, title and access level. Use the ids as owner or assignee. GET /users.

List candidates (personal data: name, emails, address, employer, skills, notes), one page at a time, max 100 per page. Use cats_search_candidates or cats_filter_candidates to find specific people. GET /candidates.

One candidate by id (personal data). GET /candidates/{id}.

Free-text search over candidates (name, email, skills, resume text...), paged. GET /candidates/search?query=.

Filter candidates by fields (read-only, although it is a POST): first_name, last_name, title, emails.primary, address.city/state/postal_code, country_code, current_employer, key_skills, notes, dates (date_created, date_modified), owner_id, is_hot... Each condition is {field, filter, value}; filters: exactly, contains, between {gte,lte}, greater_than, less_than, is_empty, geo_distance. Paged. POST /candidates/search.

The jobs a candidate is in the pipeline for, with rating, workflow and current status id. GET /candidates/{id}/pipelines.

The activity log of a candidate (calls, meetings, notes, pipeline changes), paged. GET /candidates/{id}/activities.

Tasks attached to a candidate. GET /candidates/{id}/tasks.

File names, sizes and whether each file is a resume, for a candidate's attachments. Metadata only: file contents are never downloaded. GET /candidates/{id}/attachments.

List job orders with title, location, company, recruiter, status and workflow ids, dates. Paged. GET /jobs.

One job order by id, with its description. GET /jobs/{id}.

Free-text search over job orders, paged. GET /jobs/search?query=.

The candidates in the pipeline of a job: pipeline id, candidate id, rating and current status id. Paged. GET /jobs/{id}/pipelines.

The statuses a job order can have (Active, OnHold, Closed...). GET /jobs/statuses.

List candidate-to-job pipelines (candidate id, job id, rating, workflow id, status id), paged. GET /pipelines.

One pipeline (a candidate on a job) by id. GET /pipelines/{id}.

Filter pipelines by id, candidate_id, job_id, status_id, rating, date_created or date_modified (read-only, although it is a POST). Each condition is {field, filter, value}. Paged. POST /pipelines/search.

The status changes of a pipeline over time (status, who, when). GET /pipelines/{id}/statuses.

The pipeline workflows (sets of statuses such as Contacted, Interviewing, Offered). GET /pipelines/workflows.

The statuses of one pipeline workflow (id, title, prerequisites, triggers). Use the ids with cats_change_pipeline_status. GET /pipelines/workflows/{id}/statuses.

List client companies (name, address, website, owner), paged. GET /companies.

One company by id. GET /companies/{id}.

Free-text search over companies, paged. GET /companies/search?query=.

List client contacts (personal data: name, title, emails, company), paged. GET /contacts.

One client contact by id (personal data). GET /contacts/{id}.

Free-text search over client contacts, paged. GET /contacts/search?query=.

List tasks (description, priority 1-5, due date, assignee, completion, the record it is about), paged. GET /tasks.

One task by id. GET /tasks/{id}.

The site-wide activity log (calls, emails logged, meetings, notes) with the record each is about, paged. GET /activities.

WRITE: Requires confirm:true. log an activity (a call, meeting, note...) on a candidate's record. It only records the entry in CATS: no email/SMS-send request is made, even for type 'email' or 'text_message'. Creates a new entry each time (not idempotent). POST /candidates/{id}/activities.

WRITE: Requires confirm:true. create a task in CATS, optionally about a candidate, contact, company or job and assigned to a user. Creates a new task each time (not idempotent); CATS may notify the assignee. POST /tasks.

WRITE: Requires confirm:true. change the status of a pipeline (move a candidate to another stage of a job's workflow, e.g. Interviewing, Offered, Rejected). Get the pipeline id from cats_list_candidate_pipelines and the status id from cats_list_workflow_statuses. Requires confirm:true. Requests that status triggers (which can e-mail people or change records) be suppressed: every trigger attached to the target status is sent with fire=false. CATS remains responsible for enforcing its trigger semantics; independently configured webhooks may still run. The change is recorded in the pipeline's status history. POST /pipelines/{id}/status.

WRITE: Requires confirm:true. create one candidate record (personal data) with name, optional contact details and notes. Refuses when CATS finds a duplicate (check_duplicate=true, the default). Creates a new record each time (not idempotent); no email-send request is made to the candidate and no login is created. POST /candidates.