cats-jobs

CATS Jobs - manage job openings, pipelines, and hiring workflows

Server path: /cats-jobs | Type: Application | PCID required: Yes

Tools

Tool	Description
cats_jobs_attach_job_tags	Attach job tags
cats_jobs_change_job_status	Change job status
cats_jobs_change_pipeline_status	Change pipeline status
cats_jobs_create_a_job	Create a job
cats_jobs_create_a_job_list	Create a job list
cats_jobs_create_a_pipeline	Create a pipeline
cats_jobs_create_job_list_items	Create job list items
cats_jobs_delete_a_job	Delete a job
cats_jobs_delete_a_job_list	Delete a job list
cats_jobs_delete_a_job_list_item	Delete a job list item
cats_jobs_delete_a_pipeline	Delete a pipeline
cats_jobs_delete_job_tag	Delete job tag
cats_jobs_filter_jobs	Filter jobs
cats_jobs_filter_pipelines	Filter Pipelines
cats_jobs_get_a_job	Get a job
cats_jobs_get_a_job_application	Get a job application
cats_jobs_get_a_job_custom_field	Get a job custom field
cats_jobs_get_a_job_custom_field_value	Get a job custom field value
cats_jobs_get_a_job_list	Get a job list
cats_jobs_get_a_job_list_item	Get a job list item
cats_jobs_get_a_job_status	Get a job status
cats_jobs_get_a_pipeline	Get a pipeline
cats_jobs_get_a_workflow	Get a workflow
cats_jobs_get_a_workflow_status	Get a workflow status
cats_jobs_get_pipeline_historical_statuses	Get pipeline historical statuses
cats_jobs_list_all_job_list_items	List all job list items
cats_jobs_list_all_job_lists	List all job lists
cats_jobs_list_all_job_tags	List all job tags
cats_jobs_list_all_jobs	List all jobs
cats_jobs_list_all_pipelines	List all pipelines
cats_jobs_list_applications_by_job	List applications by job
cats_jobs_list_job_application_fields	List job application fields
cats_jobs_list_job_attachments	List job attachments
cats_jobs_list_job_custom_field_values	List job custom field values
cats_jobs_list_job_custom_fields	List job custom fields
cats_jobs_list_job_statuses	List job statuses
cats_jobs_list_job_tasks	List job tasks
cats_jobs_list_pipelines_by_job	List pipelines by job
cats_jobs_list_workflow_statuses	List workflow statuses
cats_jobs_list_workflows	List workflows
cats_jobs_replace_job_tags	Replace job tags
cats_jobs_search_jobs	Search jobs
cats_jobs_update_a_job	Update a job
cats_jobs_update_a_job_custom_field	Update a job custom field
cats_jobs_update_a_pipeline	Update a pipeline
cats_jobs_upload_a_job_attachment	Upload a job attachment

---

cats_jobs_attach_job_tags

Attach job tags

Parameters:

Parameter	Type	Required	Default	Description
job_id	number	Yes	—	The ID of the job to attach tags to.
tags	any[]	No	—	The tags value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job_id": {
      "type": "number",
      "description": "The ID of the job to attach tags to."
    },
    "tags": {
      "type": "array",
      "description": "The tags value"
    }
  },
  "required": [
    "PCID",
    "job_id"
  ]
}

---

cats_jobs_change_job_status

Change job status

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job that the status is being attached to.
status_id	number	Yes	—	The ID of the status to attach.
triggers	any[]	No	—	An array of objects each containing the ID of an attached trigger and a boolean representing whether or not to fire the trigger. If the triggers parameter is not set, all required triggers will be fired as well as all triggers that are marked as optional and on by default. Optional triggers that are off by default will not fire. If the triggers parameter is specified, all triggers that are attached to the status must be included in the array and the API will make no assumptions about which triggers to fire. Example: [ { "id": <trigger ID>, "fire": <boolean> } ]

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job that the status is being attached to."
    },
    "status_id": {
      "type": "number",
      "description": "The ID of the status to attach."
    },
    "triggers": {
      "type": "array",
      "description": "An array of objects each containing the ID of an attached trigger and a boolean representing whether or not to fire the trigger.  If the `triggers` parameter is not set, all required triggers will be fired as well as all triggers that are marked as optional and on by default. Optional triggers that are off by default will not fire.  If the `triggers` parameter is specified, *all* triggers that are attached to the status must be included in the array and the API will make no assumptions about which triggers to fire.  Example:  ``` [     {       \"id\": <trigger ID>,       \"fire\": <boolean>     } ] ```"
    }
  },
  "required": [
    "PCID",
    "id",
    "status_id"
  ]
}

---

cats_jobs_change_pipeline_status

Change pipeline status

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the pipeline that the status is being attached to.
create_activity	boolean	Yes	—	Whether a corresponding activity should be created automatically. This mimics what happens when a pipeline is created from the CATS UI. Defaults to false.
status_id	number	Yes	—	The ID of the status to attach.
triggers	any[]	No	—	An array of objects each containing the ID of an attached trigger and a boolean representing whether or not to fire the trigger. If the triggers parameter is not set, all required triggers will be fired as well as all triggers that are marked as optional and on by default. Optional triggers that are off by default will not fire. If the triggers parameter is specified, all triggers that are attached to the status must be included in the array and the API will make no assumptions about which triggers to fire. Example: [ { "id": <trigger ID>, "fire": <boolean> } ]

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the pipeline that the status is being attached to."
    },
    "create_activity": {
      "type": "boolean",
      "description": "Whether a corresponding activity should be created automatically. This mimics what happens when a pipeline is created from the CATS UI. Defaults to false."
    },
    "status_id": {
      "type": "number",
      "description": "The ID of the status to attach."
    },
    "triggers": {
      "type": "array",
      "description": "An array of objects each containing the ID of an attached trigger and a boolean representing whether or not to fire the trigger.  If the `triggers` parameter is not set, all required triggers will be fired as well as all triggers that are marked as optional and on by default. Optional triggers that are off by default will not fire.  If the `triggers` parameter is specified, *all* triggers that are attached to the status must be included in the array and the API will make no assumptions about which triggers to fire.  Example:  ``` [     {       \"id\": <trigger ID>,       \"fire\": <boolean>     } ] ```"
    }
  },
  "required": [
    "PCID",
    "id",
    "create_activity",
    "status_id"
  ]
}

---

cats_jobs_create_a_job

Create a job

Parameters:

Parameter	Type	Required	Default	Description
check_duplicate	boolean	Yes	—	When this flag is set to true, if a duplicate record is found to the one being created, an error will be thrown instead of creating a duplicate record. Defaults to false.
category_name	string	No	—	Category Name
company_id	number	Yes	—	The ID of the company the job belongs to.
contact_id	number	No	—	The ID of the contact associated with the job.
country_code	string	No	—	Country Code
custom_fields	any[]	No	—	An array of custom field objects. Each custom field object should contain two keys: id and value. id is the id of a custom field definition, and value is the value to be set to that custom field for this job. [ { "id": <custom field definition id>, "value": "<custom field value>" } ]
department_id	number	No	—	The ID of the department the job belongs to (must be a department linked to the specified company)
description	string	No	—	The description value
duration	string	No	—	The duration value
external_id	string	No	—	External Id
is_hot	boolean	No	—	Is Hot
location	object	Yes	—	An object containing the location information for the job with the following structure: { "city": "<city>", "state": "<state>", "postal_code": "<postal code>" }
max_rate	string	No	—	Max Rate
notes	string	No	—	The notes value
openings	number	No	—	The openings value
owner_id	number	No	—	The user id of the record owner
recruiter_id	number	No	—	The ID of the user who is the recruiter for the job.
salary	string	No	—	The salary value
start_date	string	No	—	Start date for filtering
title	string	Yes	—	The title value
type	string	No	—	The type value
user_groups	any[]	No	—	User groups allowed to access this job
workflow_id	number	No	—	The ID of the workflow to assign to pipelines attached to this job. If not specified, will use the default.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "check_duplicate": {
      "type": "boolean",
      "description": "When this flag is set to true, if a duplicate record is found to the one being created, an error will be thrown instead of creating a duplicate record. Defaults to false."
    },
    "category_name": {
      "type": "string",
      "description": "Category Name"
    },
    "company_id": {
      "type": "number",
      "description": "The ID of the company the job belongs to."
    },
    "contact_id": {
      "type": "number",
      "description": "The ID of the contact associated with the job."
    },
    "country_code": {
      "type": "string",
      "description": "Country Code"
    },
    "custom_fields": {
      "type": "array",
      "description": "An array of custom field objects. Each custom field object should contain two keys: `id` and `value`. `id` is the id of a custom field definition, and `value` is the value to be set to that custom field for this job.  ``` [     {         \"id\": <custom field definition id>,         \"value\": \"<custom field value>\"     } ] ```"
    },
    "department_id": {
      "type": "number",
      "description": "The ID of the department the job belongs to (must be a department linked to the specified company)"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "duration": {
      "type": "string",
      "description": "The duration value"
    },
    "external_id": {
      "type": "string",
      "description": "External Id"
    },
    "is_hot": {
      "type": "boolean",
      "description": "Is Hot"
    },
    "location": {
      "type": "object",
      "description": "An object containing the location information for the job with the following structure:  ``` {   \"city\": \"<city>\",   \"state\": \"<state>\",   \"postal_code\": \"<postal code>\" } ```",
      "properties": {
        "city": {
          "type": "string",
          "description": "The city value"
        },
        "state": {
          "type": "string",
          "description": "The state value"
        },
        "postal_code": {
          "type": "string",
          "description": "Postal Code"
        }
      }
    },
    "max_rate": {
      "type": "string",
      "description": "Max Rate"
    },
    "notes": {
      "type": "string",
      "description": "The notes value"
    },
    "openings": {
      "type": "number",
      "description": "The openings value"
    },
    "owner_id": {
      "type": "number",
      "description": "The user id of the record owner"
    },
    "recruiter_id": {
      "type": "number",
      "description": "The ID of the user who is the recruiter for the job."
    },
    "salary": {
      "type": "string",
      "description": "The salary value"
    },
    "start_date": {
      "type": "string",
      "description": "Start date for filtering"
    },
    "title": {
      "type": "string",
      "description": "The title value"
    },
    "type": {
      "type": "string",
      "description": "The type value"
    },
    "user_groups": {
      "type": "array",
      "description": "User groups allowed to access this job"
    },
    "workflow_id": {
      "type": "number",
      "description": "The ID of the workflow to assign to pipelines attached to this job. If not specified, will use the default."
    }
  },
  "required": [
    "PCID",
    "check_duplicate",
    "company_id",
    "location",
    "title"
  ]
}

---

cats_jobs_create_a_job_list

Create a job list

Parameters:

Parameter	Type	Required	Default	Description
name	string	Yes	—	The name value
notes	string	No	—	The notes value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "notes": {
      "type": "string",
      "description": "The notes value"
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

---

cats_jobs_create_a_pipeline

Create a pipeline

Parameters:

Parameter	Type	Required	Default	Description
create_activity	boolean	Yes	—	Whether a corresponding activity should be created automatically. This mimics what happens when a pipeline is created from the CATS UI. Defaults to false.
candidate_id	number	Yes	—	The ID of the candidate that this pipeline is regarding.
job_id	number	Yes	—	The ID of the job order that this pipeline is for.
rating	number	No	—	The candidate’s rating (0-5) for this job order pipeline.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "create_activity": {
      "type": "boolean",
      "description": "Whether a corresponding activity should be created automatically. This mimics what happens when a pipeline is created from the CATS UI. Defaults to false."
    },
    "candidate_id": {
      "type": "number",
      "description": "The ID of the candidate that this pipeline is regarding."
    },
    "job_id": {
      "type": "number",
      "description": "The ID of the job order that this pipeline is for."
    },
    "rating": {
      "type": "number",
      "description": "The candidate's rating (0-5) for this job order pipeline."
    }
  },
  "required": [
    "PCID",
    "create_activity",
    "candidate_id",
    "job_id"
  ]
}

---

cats_jobs_create_job_list_items

Create job list items

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job list.
items	any[]	No	—	The items value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job list."
    },
    "items": {
      "type": "array",
      "description": "The items value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_delete_a_job

Delete a job

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_delete_a_job_list

Delete a job list

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job list to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job list to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_delete_a_job_list_item

Delete a job list item

Parameters:

Parameter	Type	Required	Default	Description
list_id	number	Yes	—	The ID of the job list.
item_id	number	Yes	—	The ID of the list item to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "list_id": {
      "type": "number",
      "description": "The ID of the job list."
    },
    "item_id": {
      "type": "number",
      "description": "The ID of the list item to delete."
    }
  },
  "required": [
    "PCID",
    "list_id",
    "item_id"
  ]
}

---

cats_jobs_delete_a_pipeline

Delete a pipeline

Parameters:

Parameter	Type	Required	Default	Description
create_activity	boolean	Yes	—	Whether a corresponding activity should be created automatically. This mimics what happens when a pipeline is created from the CATS UI. Defaults to false.
id	number	Yes	—	The ID of the pipeline to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "create_activity": {
      "type": "boolean",
      "description": "Whether a corresponding activity should be created automatically. This mimics what happens when a pipeline is created from the CATS UI. Defaults to false."
    },
    "id": {
      "type": "number",
      "description": "The ID of the pipeline to delete."
    }
  },
  "required": [
    "PCID",
    "create_activity",
    "id"
  ]
}

---

cats_jobs_delete_job_tag

Delete job tag

Parameters:

Parameter	Type	Required	Default	Description
job_id	number	Yes	—	The ID of the job to detach the tag from.
tag_id	number	Yes	—	The ID of the tag to detach.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job_id": {
      "type": "number",
      "description": "The ID of the job to detach the tag from."
    },
    "tag_id": {
      "type": "number",
      "description": "The ID of the tag to detach."
    }
  },
  "required": [
    "PCID",
    "job_id",
    "tag_id"
  ]
}

---

cats_jobs_filter_jobs

Filter jobs

Parameters:

Parameter	Type	Required	Default	Description
query	string	Yes	—	The optional string to search within jobs for.
page	number	Yes	—	The current page number of jobs to return.
per_page	number	Yes	—	The number of jobs to return per page.
field	string	Yes	—	The field to filter on. See the above list to determine which fields can be filtered.
filter	string	Yes	—	The filter to use. See the above list to determine which fields allow what filters.
value	string	Yes	—	The value to filter by. Different filters take different value types (string, array, int). See the section in the introduction to see what values each filter accepts.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "query": {
      "type": "string",
      "description": "The optional string to search within jobs for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of jobs to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of jobs to return per page."
    },
    "field": {
      "type": "string",
      "description": "The field to filter on. See the above list to determine which fields can be filtered."
    },
    "filter": {
      "type": "string",
      "description": "The filter to use. See the above list to determine which fields allow what filters."
    },
    "value": {
      "type": "string",
      "description": "The value to filter by. Different filters take different value types (string, array, int). See the section in the introduction to see what values each filter accepts."
    }
  },
  "required": [
    "PCID",
    "query",
    "page",
    "per_page",
    "field",
    "filter",
    "value"
  ]
}

---

cats_jobs_filter_pipelines

Filter Pipelines

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of pipelines to return.
per_page	number	Yes	—	The number of pipelines to return per page.
field	string	Yes	—	The field to filter on. See the above list to determine which fields can be filtered.
filter	string	Yes	—	The filter to use. See the above list to determine which fields allow what filters.
value	string	Yes	—	The value to filter by. Different filters take different value types (string, array, int). See the section in the introduction to see what values each filter accepts.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of pipelines to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of pipelines to return per page."
    },
    "field": {
      "type": "string",
      "description": "The field to filter on. See the above list to determine which fields can be filtered."
    },
    "filter": {
      "type": "string",
      "description": "The filter to use. See the above list to determine which fields allow what filters."
    },
    "value": {
      "type": "string",
      "description": "The value to filter by. Different filters take different value types (string, array, int). See the section in the introduction to see what values each filter accepts."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page",
    "field",
    "filter",
    "value"
  ]
}

---

cats_jobs_get_a_job

Get a job

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_get_a_job_application

Get a job application

Parameters:

Parameter	Type	Required	Default	Description
application_id	number	Yes	—	The ID of the job application.
page	number	Yes	—	The current page number of contacts to return.
per_page	number	Yes	—	The number of contacts to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "application_id": {
      "type": "number",
      "description": "The ID of the job application."
    },
    "page": {
      "type": "number",
      "description": "The current page number of contacts to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of contacts to return per page."
    }
  },
  "required": [
    "PCID",
    "application_id",
    "page",
    "per_page"
  ]
}

---

cats_jobs_get_a_job_custom_field

Get a job custom field

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the custom field definition to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the custom field definition to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_get_a_job_custom_field_value

Get a job custom field value

Parameters:

Parameter	Type	Required	Default	Description
job_id	number	Yes	—	The ID of the job that the custom field belongs to.
custom_field_id	number	Yes	—	The ID of the custom field to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job_id": {
      "type": "number",
      "description": "The ID of the job that the custom field belongs to."
    },
    "custom_field_id": {
      "type": "number",
      "description": "The ID of the custom field to return."
    }
  },
  "required": [
    "PCID",
    "job_id",
    "custom_field_id"
  ]
}

---

cats_jobs_get_a_job_list

Get a job list

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job list to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job list to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_get_a_job_list_item

Get a job list item

Parameters:

Parameter	Type	Required	Default	Description
list_id	number	Yes	—	The ID of the job list the item belongs to.
item_id	number	Yes	—	The ID of the job list item to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "list_id": {
      "type": "number",
      "description": "The ID of the job list the item belongs to."
    },
    "item_id": {
      "type": "number",
      "description": "The ID of the job list item to return."
    }
  },
  "required": [
    "PCID",
    "list_id",
    "item_id"
  ]
}

---

cats_jobs_get_a_job_status

Get a job status

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the status to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the status to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_get_a_pipeline

Get a pipeline

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the pipeline to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the pipeline to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_get_a_workflow

Get a workflow

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the workflow to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the workflow to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_get_a_workflow_status

Get a workflow status

Parameters:

Parameter	Type	Required	Default	Description
workflow_id	number	Yes	—	The ID of the workflow to return statuses for.
status_id	number	Yes	—	The ID of the status to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflow_id": {
      "type": "number",
      "description": "The ID of the workflow to return statuses for."
    },
    "status_id": {
      "type": "number",
      "description": "The ID of the status to return."
    }
  },
  "required": [
    "PCID",
    "workflow_id",
    "status_id"
  ]
}

---

cats_jobs_get_pipeline_historical_statuses

Get pipeline historical statuses

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the pipeline to fetch status history from

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the pipeline to fetch status history from"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_list_all_job_list_items

List all job list items

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job list to return items for.
page	number	Yes	—	The current page number of list items to return.
per_page	number	Yes	—	The number of list items to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job list to return items for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of list items to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of list items to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_all_job_lists

List all job lists

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of lists to return.
per_page	number	Yes	—	The number of lists to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of lists to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of lists to return per page."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_all_job_tags

List all job tags

Parameters:

Parameter	Type	Required	Default	Description
job_id	number	Yes	—	The ID of the job to return tags for.
page	number	Yes	—	The current page number of tags to return.
per_page	number	Yes	—	The number of tags to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job_id": {
      "type": "number",
      "description": "The ID of the job to return tags for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of tags to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of tags to return per page."
    }
  },
  "required": [
    "PCID",
    "job_id",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_all_jobs

List all jobs

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of jobs to return.
per_page	number	Yes	—	The number of jobs to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of jobs to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of jobs to return per page."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_all_pipelines

List all pipelines

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of pipelines to return.
per_page	number	Yes	—	The number of pipelines to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of pipelines to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of pipelines to return per page."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_applications_by_job

List applications by job

Parameters:

Parameter	Type	Required	Default	Description
job_id	number	Yes	—	The ID of the job to return applications for.
page	number	Yes	—	The current page number of contacts to return.
per_page	number	Yes	—	The number of contacts to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job_id": {
      "type": "number",
      "description": "The ID of the job to return applications for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of contacts to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of contacts to return per page."
    }
  },
  "required": [
    "PCID",
    "job_id",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_job_application_fields

List job application fields

Parameters:

Parameter	Type	Required	Default	Description
application_id	number	Yes	—	The ID of the job application.
page	number	Yes	—	The current page number of contacts to return.
per_page	number	Yes	—	The number of contacts to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "application_id": {
      "type": "number",
      "description": "The ID of the job application."
    },
    "page": {
      "type": "number",
      "description": "The current page number of contacts to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of contacts to return per page."
    }
  },
  "required": [
    "PCID",
    "application_id",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_job_attachments

List job attachments

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the candidate to return attachments for.
page	number	Yes	—	The current page number of attachments to return.
per_page	number	Yes	—	The number of attachments to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the candidate to return attachments for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of attachments to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of attachments to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_job_custom_field_values

List job custom field values

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job to return custom fields for.
page	number	Yes	—	The current page number of custom fields to return.
per_page	number	Yes	—	The number of custom fields to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job to return custom fields for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of custom fields to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of custom fields to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_job_custom_fields

List job custom fields

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of custom field definitions to return.
per_page	number	Yes	—	The number of custom field definitions to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of custom field definitions to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of custom field definitions to return per page."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_job_statuses

List job statuses

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of statuses to return.
per_page	number	Yes	—	The number of statuses to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of statuses to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of statuses to return per page."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_job_tasks

List job tasks

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job to fetch tasks concerning.
page	number	Yes	—	The current page number of tasks to return.
per_page	number	Yes	—	The number of task items to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job to fetch tasks concerning."
    },
    "page": {
      "type": "number",
      "description": "The current page number of tasks to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of task items to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_pipelines_by_job

List pipelines by job

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job to return pipelines for.
page	number	Yes	—	The current page number of pipelines to return.
per_page	number	Yes	—	The number of pipelines to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job to return pipelines for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of pipelines to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of pipelines to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

---

cats_jobs_list_workflow_statuses

List workflow statuses

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of statuses to return.
per_page	number	Yes	—	The number of statuses to return per page.
workflow_id	number	Yes	—	The ID of the workflow to return statuses for.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of statuses to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of statuses to return per page."
    },
    "workflow_id": {
      "type": "number",
      "description": "The ID of the workflow to return statuses for."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page",
    "workflow_id"
  ]
}

---

cats_jobs_list_workflows

List workflows

Parameters:

Parameter	Type	Required	Default	Description
page	number	Yes	—	The current page number of workflows to return.
per_page	number	Yes	—	The number of workflows to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "number",
      "description": "The current page number of workflows to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of workflows to return per page."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page"
  ]
}

---

cats_jobs_replace_job_tags

Replace job tags

Parameters:

Parameter	Type	Required	Default	Description
job_id	number	Yes	—	The ID of the job to replace tags on.
tags	any[]	No	—	The tags value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job_id": {
      "type": "number",
      "description": "The ID of the job to replace tags on."
    },
    "tags": {
      "type": "array",
      "description": "The tags value"
    }
  },
  "required": [
    "PCID",
    "job_id"
  ]
}

---

cats_jobs_search_jobs

Search jobs

Parameters:

Parameter	Type	Required	Default	Description
query	string	Yes	—	The string to search within jobs for.
page	number	Yes	—	The current page number of jobs to return.
per_page	number	Yes	—	The number of jobs to return per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "query": {
      "type": "string",
      "description": "The string to search within jobs for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of jobs to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of jobs to return per page."
    }
  },
  "required": [
    "PCID",
    "query",
    "page",
    "per_page"
  ]
}

---

cats_jobs_update_a_job

Update a job

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job to update.
category_name	string	No	—	Category Name
company_id	number	No	—	The ID of the company the job belongs to.
contact_id	number	No	—	The ID of the contact associated with the job.
country_code	string	No	—	Country Code
custom_fields	any[]	No	—	An array of custom field objects. Each custom field object should contain two keys: id and value. id is the id of a custom field definition, and value is the value to be set to that custom field for this job. [ { "id": <custom field definition id>, "value": "<custom field value>" } ]
department_id	number	No	—	The ID of the department the job belongs to (must be a department linked to the specified company)
description	string	No	—	The description value
duration	string	No	—	The duration value
external_id	string	No	—	External Id
is_hot	boolean	No	—	Is Hot
location	object	No	—	An object containing the location information for the job with the following structure: { "city": "<city>", "state": "<state>", "postal_code": "<postal code>" }
max_rate	string	No	—	Max Rate
notes	string	No	—	The notes value
openings	number	No	—	The openings value
owner_id	number	No	—	The user id of the record owner
recruiter_id	number	No	—	The ID of the user who is the recruiter for the job.
salary	string	No	—	The salary value
start_date	string	No	—	Start date for filtering
title	string	No	—	The title value
type	string	No	—	The type value
user_groups	any[]	No	—	User groups allowed to access this job

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job to update."
    },
    "category_name": {
      "type": "string",
      "description": "Category Name"
    },
    "company_id": {
      "type": "number",
      "description": "The ID of the company the job belongs to."
    },
    "contact_id": {
      "type": "number",
      "description": "The ID of the contact associated with the job."
    },
    "country_code": {
      "type": "string",
      "description": "Country Code"
    },
    "custom_fields": {
      "type": "array",
      "description": "An array of custom field objects. Each custom field object should contain two keys: `id` and `value`. `id` is the id of a custom field definition, and `value` is the value to be set to that custom field for this job.  ``` [     {         \"id\": <custom field definition id>,         \"value\": \"<custom field value>\"     } ] ```"
    },
    "department_id": {
      "type": "number",
      "description": "The ID of the department the job belongs to (must be a department linked to the specified company)"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "duration": {
      "type": "string",
      "description": "The duration value"
    },
    "external_id": {
      "type": "string",
      "description": "External Id"
    },
    "is_hot": {
      "type": "boolean",
      "description": "Is Hot"
    },
    "location": {
      "type": "object",
      "description": "An object containing the location information for the job with the following structure:  ``` {   \"city\": \"<city>\",   \"state\": \"<state>\",   \"postal_code\": \"<postal code>\" } ```",
      "properties": {
        "city": {
          "type": "string",
          "description": "The city value"
        },
        "state": {
          "type": "string",
          "description": "The state value"
        },
        "postal_code": {
          "type": "string",
          "description": "Postal Code"
        }
      }
    },
    "max_rate": {
      "type": "string",
      "description": "Max Rate"
    },
    "notes": {
      "type": "string",
      "description": "The notes value"
    },
    "openings": {
      "type": "number",
      "description": "The openings value"
    },
    "owner_id": {
      "type": "number",
      "description": "The user id of the record owner"
    },
    "recruiter_id": {
      "type": "number",
      "description": "The ID of the user who is the recruiter for the job."
    },
    "salary": {
      "type": "string",
      "description": "The salary value"
    },
    "start_date": {
      "type": "string",
      "description": "Start date for filtering"
    },
    "title": {
      "type": "string",
      "description": "The title value"
    },
    "type": {
      "type": "string",
      "description": "The type value"
    },
    "user_groups": {
      "type": "array",
      "description": "User groups allowed to access this job"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_update_a_job_custom_field

Update a job custom field

Parameters:

Parameter	Type	Required	Default	Description
job_id	number	Yes	—	The ID of the job that the custom field belongs to.
custom_field_id	number	Yes	—	The ID of the custom field to update.
value	string	No	—	The value value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "job_id": {
      "type": "number",
      "description": "The ID of the job that the custom field belongs to."
    },
    "custom_field_id": {
      "type": "number",
      "description": "The ID of the custom field to update."
    },
    "value": {
      "type": "string",
      "description": "The value value"
    }
  },
  "required": [
    "PCID",
    "job_id",
    "custom_field_id"
  ]
}

---

cats_jobs_update_a_pipeline

Update a pipeline

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the pipeline to update.
rating	number	No	—	The candidate’s rating (0-5) for this job order pipeline.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the pipeline to update."
    },
    "rating": {
      "type": "number",
      "description": "The candidate's rating (0-5) for this job order pipeline."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cats_jobs_upload_a_job_attachment

Upload a job attachment

Parameters:

Parameter	Type	Required	Default	Description
id	number	Yes	—	The ID of the job that the attachment is being attached to.
filename	string	Yes	—	The name to save the file being uploaded as.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the job that the attachment is being attached to."
    },
    "filename": {
      "type": "string",
      "description": "The name to save the file being uploaded as."
    }
  },
  "required": [
    "PCID",
    "id",
    "filename"
  ]
}