Skip to content
Changelog

Report a bug

Cats integration: operations for AI agents

Cats connects to Type.com as an integration. This page lists the 224 operations documented for Claude and Codex in Type.com: 119 read, 48 write, 57 destructive.

About Cats

CATS is an applicant tracking system for recruiting workflows, candidates, jobs, and applications.

Categories: Human Resources

How to connect Cats to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

224 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

224 operations listed.

Activities

  • Read

    List all activities

    GET /activities

  • Read

    Get an activity

    GET /activities/{id}

  • Read

    Search activities

    GET /activities/search

  • Write

    Filter activities

    This section describes the filters and fields that can be used to filter search results for this endpoint. The example given is the most simple way to pass a filter into the call.

  • Destructive

    Update an activity

    PUT /activities/{id}

  • Destructive

    Delete an activity

    DELETE /activities/{id}

Attachments

  • Read

    Get an attachment

    GET /attachments/{id}

  • Read

    Download an attachment

    GET /attachments/{id}/download

  • Write

    Parse a resume

    Parses the supplied resume and returns a candidate object. No records are created or updated with this call.

  • Destructive

    Delete an attachment

    DELETE /attachments/{id}

Backups

  • Read

    List all backups

    GET /backups

  • Read

    Get a backup

    GET /backups/{id}

  • Write

    Create a backup

    This will initiate the creation of a backup. As with all POST endpoints, a location header will be returned for the new backup item. You can query that endpoint to learn the status of the backup, and once it is completed to get its url.

Candidates

  • Read

    List all candidates

    GET /candidates

  • Read

    Get a candidate

    GET /candidates/{id}

  • Read

    List pipelines by candidate

    List all pipelines associated with a candidate.

  • Read

    List candidate tasks

    GET /candidates/{id}/tasks

  • Read

    Search candidates

    GET /candidates/search

  • Read

    List candidate phones

    GET /candidates/{candidate_id}/phones

  • Read

    Get a candidate phone

    GET /candidates/{candidate_id}/phones/{id}

  • Read

    List candidate emails

    GET /candidates/{candidate_id}/emails

  • Read

    Get a candidate email

    GET /candidates/{candidate_id}/emails/{id}

  • Read

    List candidate custom fields

    List all custom field definitions associated with the candidate data item type. Returned field type will always be one of text, textarea, checkbox, date, dropdown, radio, checkboxes, user, or number.

  • Read

    Get a candidate custom field

    Returned field type will always be one of text, textarea, checkbox, date, dropdown, radio, checkboxes, user, or number.

  • Read

    List candidate custom field values

    List all custom field values associated with a candidate. This returns the values of all custom fields for the candidate data item type for a single candidate.

  • Read

    Get a candidate custom field value

    Get a single custom field value for a candidate.

  • Read

    List candidate activities

    List all activities associated with a candidate.

  • Read

    List a candidate attachments

    GET /candidates/{id}/attachments

  • Read

    List candidate work history

    GET /candidates/{id}/work_history

  • Read

    Get a candidate work history item

    GET /candidates/work_history/{id}

  • Read

    List all candidate lists

    GET /candidates/lists

  • Read

    Get a candidate list

    GET /candidates/lists/{id}

  • Read

    List all candidate list items

    GET /candidates/lists/{id}/items

  • Read

    Get a candidate list item

    GET /candidates/lists/{list_id}/items/{item_id}

  • Read

    List applications by candidate

    GET /candidates/{candidate_id}/applications

  • Read

    Get a candidate application

    GET /candidates/applications/{application_id}

  • Read

    List all candidate tags

    GET /candidates/{candidate_id}/tags

  • Read

    Get a candidate thumbnail

    GET /candidates/{id}/thumbnail

  • Write

    Create a candidate

    As with all POST endpoints, a location header will be returned with a url to the newly created resource.

  • Write

    Authorize a candidate

    Check if an email and password match an existing candidate. Returns the Candidate if authorized, or a 404 if not. You can use this endpoint to allow a user to "log in" and edit their contact data.

  • Write

    Filter candidates

    This section describes the filters and fields that can be used to filter search results for this endpoint. The example given is the most simple way to pass a filter into the call.

  • Write

    Create a candidate phone

    POST /candidates/{candidate_id}/phones

  • Write

    Create a candidate email

    POST /candidates/{candidate_id}/emails

  • Write

    Create a candidate activity

    Log an activity against a candidate.

  • Write

    Upload a candidate attachment

    POST /candidates/{id}/attachments

  • Write

    Upload a resume

    Resumes are attachments that are marked as a resume in a candidate's profile and are indexed for boolean keyword search. They are otherwise identical to standard attachments.

  • Write

    Create a candidate work history item

    POST /candidates/{id}/work_history

  • Write

    Create a candidate list

    POST /candidates/lists

  • Write

    Create candidate list items

    Creating candidate list items attaches the specified candidates to a list.

  • Write

    Replace candidate tags

    This will replace all tags on the candidate with the tags specified in this call. To remove all tags from an item, send an empty tag array.

  • Destructive

    Update a candidate

    PUT /candidates/{id}

  • Destructive

    Delete a candidate

    DELETE /candidates/{id}

  • Destructive

    Update a candidate phone

    PUT /candidates/{candidate_id}/phones/{id}

  • Destructive

    Delete a candidate phone

    DELETE /candidates/{candidate_id}/phones/{id}

  • Destructive

    Update a candidate email

    PUT /candidates/{candidate_id}/emails/{id}

  • Destructive

    Delete a candidate email

    DELETE /candidates/{candidate_id}/emails/{id}

  • Destructive

    Update a candidate custom field

    PUT /candidates/{candidate_id}/custom_fields/{custom_field_id}

  • Destructive

    Update a candidate work history item

    PUT /candidates/work_history/{id}

  • Destructive

    Delete a candidate work history item

    DELETE /candidates/work_history/{id}

  • Destructive

    Delete a candidate list

    DELETE /candidates/lists/{id}

  • Destructive

    Delete a candidate list item

    Deleting a candidate list item removes a candidate from a list.

  • Destructive

    Attach candidate tags

    This will not delete any existing tags on the candidate.

  • Destructive

    Delete candidate tag

    Detaches an individual tag from the candidate.

  • Destructive

    Change a candidate thumbnail

    PUT /candidates/{id}/thumbnail

Companies

  • Read

    List all companies

    GET /companies

  • Read

    Get a company

    GET /companies/{id}

  • Read

    List company tasks

    GET /companies/{id}/tasks

  • Read

    Search companies

    GET /companies/search

  • Read

    List company phones

    GET /companies/{company_id}/phones

  • Read

    Get a company phone

    GET /companies/{company_id}/phones/{id}

  • Read

    List company custom fields

    List all custom field definitions associated with the company data item type. Returned field type will always be one of text, textarea, checkbox, date, dropdown, radio, checkboxes, user or number.

  • Read

    Get a company custom field

    Returned field type will always be one of text, textarea, checkbox, date, dropdown, radio, checkboxes, user or number.

  • Read

    List company custom field values

    List all custom field values associated with a company. This returns the values of all custom fields for the company data item type for a single company.

  • Read

    Get a company custom field value

    Get a single custom field value for a company.

  • Read

    List company statuses

    GET /companies/statuses

  • Read

    Get a company status

    GET /companies/statuses/{id}

  • Read

    List company attachments

    GET /companies/{id}/attachments

  • Read

    List all company lists

    GET /companies/lists

  • Read

    Get a list

    GET /companies/lists/{id}

  • Read

    List all company list items

    GET /companies/lists/{id}/items

  • Read

    Get a company list item

    GET /companies/lists/{list_id}/items/{item_id}

  • Read

    List all company tags

    GET /companies/{company_id}/tags

  • Read

    List all departments

    GET /companies/{company_id}/departments

  • Read

    Get a department

    GET /companies/departments/{id}

  • Read

    Get a company thumbnail

    GET /companies/{id}/thumbnail

  • Write

    Create a company

    As with all POST endpoints, a location header will be returned with a url to the newly created resource.

  • Write

    Filter companies

    This section describes the filters and fields that can be used to filter search results for this endpoint. The example given is the most simple way to pass a filter into the call.

  • Write

    Create a company phone

    POST /companies/{company_id}/phones

  • Write

    Change company status

    POST /companies/{id}/status

  • Write

    Upload a company attachment

    POST /companies/{id}/attachments

  • Write

    Create a company list

    POST /companies/lists

  • Write

    Create company list items

    Creating company list items attaches the specified companies to a list.

  • Write

    Replace company tags

    This will replace all tags on the company with the tags specified in this call. To remove all tags from an item, send an empty tag array.

  • Write

    Add department

    POST /companies/{company_id}/departments

  • Destructive

    Update a company

    PUT /companies/{id}

  • Destructive

    Delete a company

    DELETE /companies/{id}

  • Destructive

    Update a company phone

    PUT /companies/{company_id}/phones/{id}

  • Destructive

    Delete a company phone

    DELETE /companies/{company_id}/phones/{id}

  • Destructive

    Update a company custom field

    PUT /companies/{company_id}/custom_fields/{custom_field_id}

  • Destructive

    Delete a company list

    DELETE /companies/lists/{id}

  • Destructive

    Delete a company list item

    Deleting a company list item removes a company from a list.

  • Destructive

    Attach company tags

    This will not delete any existing tags on the company.

  • Destructive

    Delete company tag

    Detaches an individual tag from the company.

  • Destructive

    Update department

    PUT /companies/departments/{department_id}

  • Destructive

    Delete department

    DELETE /companies/departments/{department_id}

  • Destructive

    Change a company thumbnail

    PUT /companies/{id}/thumbnail

Contacts

  • Read

    List all contacts

    GET /contacts

  • Read

    Get a contact

    GET /contacts/{id}

  • Read

    List contact tasks

    GET /contacts/{id}/tasks

  • Read

    Search contacts

    GET /contacts/search

  • Read

    Lis contact phones

    GET /contacts/{contact_id}/phones

  • Read

    Get a contact phone

    GET /contacts/{contact_id}/phones/{id}

  • Read

    List contact emails

    GET /contacts/{contact_id}/emails

  • Read

    Get a contact email

    GET /contacts/{contact_id}/emails/{id}

  • Read

    List contact custom fields

    List all custom field definitions associated with the contact data item type. Returned field type will always be one of text, textarea, checkbox, date, dropdown, radio, checkboxes, user or number.

  • Read

    Get a contact custom field

    Returned field type will always be one of text, textarea, checkbox, date, dropdown, radio, checkboxes, user or number.

  • Read

    List contact custom field values

    List all custom field values associated with a contact. This returns the values of all custom fields for the contact data item type for a single contact.

  • Read

    Get a contact custom field value

    Get a single custom field value for a contact.

  • Read

    List contact activities

    List all activities associated with a contact.

  • Read

    List contact statuses

    GET /contacts/statuses

  • Read

    Get contact status

    GET /contacts/statuses/{id}

  • Read

    List contact attachments

    GET /contacts/{id}/attachments

  • Read

    List all contact lists

    GET /contacts/lists

  • Read

    Get a contact list

    GET /contacts/lists/{id}

  • Read

    List all contact list items

    GET /contacts/lists/{id}/items

  • Read

    Get a contact list item

    GET /contacts/lists/{list_id}/items/{item_id}

  • Read

    List all contact tags

    GET /contacts/{contact_id}/tags

  • Read

    Get a contact thumbnail

    GET /contacts/{id}/thumbnail

  • Write

    Create a contact

    As with all POST endpoints, a location header will be returned with a url to the newly created resource.

  • Write

    Filter contacts

    This section describes the filters and fields that can be used to filter search results for this endpoint. The example given is the most simple way to pass a filter into the call.

  • Write

    Create a contact phone

    POST /contacts/{contact_id}/phones

  • Write

    Create a contact email

    POST /contacts/{contact_id}/emails

  • Write

    Create a contact activity

    Log an activity against a contact.

  • Write

    Change contact status

    POST /contacts/{id}/status

  • Write

    Upload a contact attachment

    POST /contacts/{id}/attachments

  • Write

    Create a contact list

    POST /contacts/lists

  • Write

    Create contact list items

    Creating contact list items attaches the specified contacts to a list.

  • Write

    Replace contact tags

    This will replace all tags on the contact with the tags specified in this call. To remove all tags from an item, send an empty tag array.

  • Destructive

    Update a contact

    PUT /contacts/{id}

  • Destructive

    Delete a contact

    DELETE /contacts/{id}

  • Destructive

    Update a contact phone

    PUT /contacts/{contact_id}/phones/{id}

  • Destructive

    Delete a contact phone

    DELETE /contacts/{contact_id}/phones/{id}

  • Destructive

    Update a contact email

    PUT /contacts/{contact_id}/emails/{id}

  • Destructive

    Delete a contact email

    DELETE /contacts/{contact_id}/emails/{id}

  • Destructive

    Update a contact custom field

    PUT /contacts/{contact_id}/custom_fields/{custom_field_id}

  • Destructive

    Delete a contact list

    DELETE /contacts/lists/{id}

  • Destructive

    Delete a contact list item

    Deleting a contact list item removes a contact from a list.

  • Destructive

    Attach contact tags

    This will not delete any existing tags on the contact.

  • Destructive

    Delete contact tag

    Detaches an individual tag from the contact.

  • Destructive

    Change a contact thumbnail

    PUT /contacts/{id}/thumbnail

Events

  • Read

    List all events starting after a timestamp

    This will return up to 25 events starting after (and not including) the provided timestamp. The resulting hal collection will also contain the next url you need to poll to get the next set of events. Fetching by id is preferable to fetching by timestamp.

Jobs

  • Read

    List all jobs

    GET /jobs

  • Read

    Get a job

    GET /jobs/{id}

  • Read

    List pipelines by job

    List all pipelines associated with a job.

  • Read

    List job tasks

    GET /jobs/{id}/tasks

  • Read

    Search jobs

    GET /jobs/search

  • Read

    List job custom fields

    List all custom field definitions associated with the job data item type. Returned field type will always be one of text, textarea, checkbox, date, dropdown, radio, checkboxes, user or number.

  • Read

    Get a job custom field

    Returned field type will always be one of text, textarea, checkbox, date, dropdown, radio, checkboxes, user or number.

  • Read

    List job custom field values

    List all custom field values associated with a job. This returns the values of all custom fields for the job data item type for a single job. See the Custom Fields documentation for information on retrieving custom field definitions.

  • Read

    Get a job custom field value

    Get a single custom field value for a job.

  • Read

    List job statuses

    GET /jobs/statuses

  • Read

    Get a job status

    GET /jobs/statuses/{id}

  • Read

    List job attachments

    GET /jobs/{id}/attachments

  • Read

    List all job lists

    GET /jobs/lists

  • Read

    Get a job list

    GET /jobs/lists/{id}

  • Read

    List all job list items

    GET /jobs/lists/{id}/items

  • Read

    Get a job list item

    GET /jobs/lists/{list_id}/items/{item_id}

  • Read

    List applications by job

    GET /jobs/{job_id}/applications

  • Read

    Get a job application

    GET /jobs/applications/{application_id}

  • Read

    List job application fields

    GET /jobs/applications/{application_id}/fields

  • Read

    List all job tags

    GET /jobs/{job_id}/tags

  • Write

    Create a job

    As with all POST endpoints, a location header will be returned with a url to the newly created resource.

  • Write

    Filter jobs

    This section describes the filters and fields that can be used to filter search results for this endpoint. The example given is the most simple way to pass a filter into the call.

  • Write

    Change job status

    POST /jobs/{id}/status

  • Write

    Upload a job attachment

    POST /jobs/{id}/attachments

  • Write

    Create a job list

    POST /jobs/lists

  • Write

    Create job list items

    Creating job list items attaches the specified jobs to a list.

  • Write

    Replace job tags

    This will replace all tags on the job with the tags specified in this call. To remove all tags from an item, send an empty tag array.

  • Destructive

    Update a job

    PUT /jobs/{id}

  • Destructive

    Delete a job

    DELETE /jobs/{id}

  • Destructive

    Update a job custom field

    PUT /jobs/{job_id}/custom_fields/{custom_field_id}

  • Destructive

    Delete a job list

    DELETE /jobs/lists/{id}

  • Destructive

    Delete a job list item

    Deleting a job list item removes a job from a list.

  • Destructive

    Attach job tags

    This will not delete any existing tags on the candidate.

  • Destructive

    Delete job tag

    Detaches an individual tag from the job.

Pipelines

  • Read

    List all pipelines

    GET /pipelines

  • Read

    Get a pipeline

    GET /pipelines/{id}

  • Read

    List workflows

    GET /pipelines/workflows

  • Read

    Get a workflow

    GET /pipelines/workflows/{id}

  • Read

    List workflow statuses

    GET /pipelines/workflows/{workflow_id}/statuses

  • Read

    Get a workflow status

    GET /pipelines/workflows/{workflow_id}/statuses/{status_id}

  • Read

    Get pipeline historical statuses

    GET /pipelines/{id}/statuses

  • Write

    Create a pipeline

    As with all POST endpoints, a location header will be returned with a url to the newly created resource.

  • Write

    Filter Pipelines

    This section describes the filters and fields that can be used to filter search results for this endpoint. The example given is the most simple way to pass a filter into the call.

  • Write

    Change pipeline status

    POST /pipelines/{id}/status

  • Destructive

    Update a pipeline

    PUT /pipelines/{id}

  • Destructive

    Delete a pipeline

    DELETE /pipelines/{id}

Portals

  • Read

    List all portals

    This endpoint returns basic portal metadata. In addition to the fields shown in the example below, within the links object you will find portalurl which has a direct link to your portal site.

  • Read

    Get a portal

    This endpoint returns basic portal metadata. In addition to the fields shown in the example below, within the links object you will find portalurl which has a direct link to your portal site.

  • Read

    List portal jobs

    This endpoint returns jobs that have been published to a particular portal. In addition to the fields shown in the example below, within the links object you will find joburl which has a direct link to the job on your portal.

  • Read

    Get portal registration application

    GET /portals/{id}/registration

  • Write

    Submit

    Using this endpoint, you can submit a new application for a specific job on a portal. The body of this request should have a fields key with an array of job application field objects as its value.

  • Write

    Submit portal registration application

    Using this endpoint, you can submit a portal registration application. The body of this request follows the same structure as the normal submit endpoint but with the portal registration application instead of a job application.

  • Destructive

    Publish portal job

    This endpoint allows you to publish a job to a portal. This will not publish the job to any third-party boards.

  • Destructive

    Unpublish portal job

    This endpoint allows you to remove a job from a portal

Site

  • Read

    Get site

    GET /site

Tags

  • Read

    List all tags

    GET /tags

  • Read

    Get a tag

    GET /tags/{id}

Tasks

  • Read

    List all tasks

    GET /tasks

  • Read

    Get a task

    GET /tasks/{id}

  • Write

    Create a task

    As with all POST endpoints, a location header will be returned with a url to the newly created resource.

  • Destructive

    Update a task

    PUT /tasks/{id}

  • Destructive

    Delete a task

    DELETE /tasks/{id}

Triggers

  • Read

    List all triggers

    GET /triggers

  • Read

    Get a trigger

    GET /triggers/{id}

Users

  • Read

    List all users

    GET /users

  • Read

    Get a user

    GET /users/{id}

Webhooks

  • Read

    List all webhooks

    GET /webhooks

  • Read

    Get a webhook

    GET /webhooks/{id}

  • Write

    Create a webhook

    As with all POST endpoints, a location header will be returned with a url to the newly created resource.

  • Destructive

    Delete a webhook

    A webhook will also be deleted if targeturl responds with status code 410.

Work History

  • Read

    Get a work history

    GET /work_history/{work_history_id}

  • Destructive

    Update a work history

    PUT /work_history/{work_history_id}

  • Destructive

    Delete a work history

    DELETE /work_history/{work_history_id}

See How connections work for access and permissions, or browse all integrations.