cats-candidates - Pinkfish - AI Agents & Workflows for Getting Work Done

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

Tools

Tool	Description
`cats_candidates_attach_candidate_tags`	Attach candidate tags
`cats_candidates_authorize_a_candidate`	Authorize a candidate
`cats_candidates_change_a_candidate_thumbnail`	Change a candidate thumbnail
`cats_candidates_create_a_candidate`	Create a candidate
`cats_candidates_create_a_candidate_activity`	Create a candidate activity
`cats_candidates_create_a_candidate_email`	Create a candidate email
`cats_candidates_create_a_candidate_list`	Create a candidate list
`cats_candidates_create_a_candidate_phone`	Create a candidate phone
`cats_candidates_create_a_candidate_work_history_item`	Create a candidate work history item
`cats_candidates_create_candidate_list_items`	Create candidate list items
`cats_candidates_delete_a_candidate`	Delete a candidate
`cats_candidates_delete_a_candidate_email`	Delete a candidate email
`cats_candidates_delete_a_candidate_list`	Delete a candidate list
`cats_candidates_delete_a_candidate_list_item`	Delete a candidate list item
`cats_candidates_delete_a_candidate_phone`	Delete a candidate phone
`cats_candidates_delete_a_candidate_work_history_item`	Delete a candidate work history item
`cats_candidates_delete_candidate_tag`	Delete candidate tag
`cats_candidates_filter_candidates`	Filter candidates
`cats_candidates_get_a_candidate`	Get a candidate
`cats_candidates_get_a_candidate_application`	Get a candidate application
`cats_candidates_get_a_candidate_custom_field`	Get a candidate custom field
`cats_candidates_get_a_candidate_custom_field_value`	Get a candidate custom field value
`cats_candidates_get_a_candidate_email`	Get a candidate email
`cats_candidates_get_a_candidate_list`	Get a candidate list
`cats_candidates_get_a_candidate_list_item`	Get a candidate list item
`cats_candidates_get_a_candidate_phone`	Get a candidate phone
`cats_candidates_get_a_candidate_thumbnail`	Get a candidate thumbnail
`cats_candidates_get_a_candidate_work_history_item`	Get a candidate work history item
`cats_candidates_list_a_candidate_attachments`	List a candidate attachments
`cats_candidates_list_all_candidate_list_items`	List all candidate list items
`cats_candidates_list_all_candidate_lists`	List all candidate lists
`cats_candidates_list_all_candidate_tags`	List all candidate tags
`cats_candidates_list_all_candidates`	List all candidates
`cats_candidates_list_applications_by_candidate`	List applications by candidate
`cats_candidates_list_candidate_activities`	List candidate activities
`cats_candidates_list_candidate_custom_field_values`	List candidate custom field values
`cats_candidates_list_candidate_custom_fields`	List candidate custom fields
`cats_candidates_list_candidate_emails`	List candidate emails
`cats_candidates_list_candidate_phones`	List candidate phones
`cats_candidates_list_candidate_tasks`	List candidate tasks
`cats_candidates_list_candidate_work_history`	List candidate work history
`cats_candidates_list_pipelines_by_candidate`	List pipelines by candidate
`cats_candidates_replace_candidate_tags`	Replace candidate tags
`cats_candidates_search_candidates`	Search candidates
`cats_candidates_update_a_candidate`	Update a candidate
`cats_candidates_update_a_candidate_custom_field`	Update a candidate custom field
`cats_candidates_update_a_candidate_email`	Update a candidate email
`cats_candidates_update_a_candidate_phone`	Update a candidate phone
`cats_candidates_update_a_candidate_work_history_item`	Update a candidate work history item
`cats_candidates_upload_a_candidate_attachment`	Upload a candidate attachment
`cats_candidates_upload_a_resume`	Upload a resume

cats_candidates_attach_candidate_tags

Attach candidate tags Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The ID of the candidate 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"
    },
    "candidate_id": {
      "type": "number",
      "description": "The ID of the candidate to attach tags to."
    },
    "tags": {
      "type": "array",
      "description": "The tags value"
    }
  },
  "required": [
    "PCID",
    "candidate_id"
  ]
}

cats_candidates_authorize_a_candidate

Authorize a candidate Parameters:

Parameter	Type	Required	Default	Description
`email`	string	No	—	The email value
`password`	string	No	—	The password value

Show inputSchema

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

cats_candidates_change_a_candidate_thumbnail

Change a candidate thumbnail Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate to change the thumbnail of.
`attachment_id`	number	No	—	Only required if source is set to `attachment` (must be an attachment belonging to the data item)
`source`	string	No	—	One of `attachment`, `gravatar`, or `disabled`.

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 change the thumbnail of."
    },
    "attachment_id": {
      "type": "number",
      "description": "Only required if source is set to `attachment` (must be an attachment belonging to the data item)"
    },
    "source": {
      "type": "string",
      "description": "One of `attachment`, `gravatar`, or `disabled`."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_candidates_create_a_candidate

Create a candidate 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.
`address`	object	No	—	An object containing the address for the candidate with the following structure: `{ "street": "<street>", "city": "<city>", "state": "<state>", "postal_code": "<postal code>" }`
`best_time_to_call`	string	No	—	Best Time To Call
`country_code`	string	No	—	Country Code
`current_employer`	string	No	—	Current Employer
`current_pay`	string	No	—	Current Pay
`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 candidate. `[ { "id": <custom field definition id>, "value": "<custom field value>" } ]`
`date_available`	string	No	—	The date the candidate is available for an opening.
`desired_pay`	string	No	—	Desired Pay
`emails`	any[]	No	—	An array of email objects. Each email object should contain two keys: `email` and `is_primary`, as described here `[ { "email": <email>, "is_primary": "<is this the primary email?>" } ]`
`first_name`	string	Yes	—	First Name
`is_active`	boolean	No	—	A flag indicating if the candidate is active.
`is_hot`	boolean	No	—	A flag indicating if the candidate should be marked as hot. A hot candidate is highlighted in the candidates view.
`is_willing_to_relocate`	boolean	No	—	Is Willing To Relocate
`key_skills`	string	No	—	Key Skills
`last_name`	string	Yes	—	Last Name
`middle_name`	string	No	—	Middle Name
`notes`	string	No	—	The notes value
`owner_id`	number	No	—	The user id of the record owner
`password`	string	No	—	The candidate’s password if they are “registering”. Registered candidate can be authenticated with `/candidates/authorization`.
`phones`	any[]	No	—	An array of phone objects. Each phone object should contain three keys: `number`, `extension`, and `type`, as described here `[ { "number": <phone number with country code>, "extension": "<optional extension>", "type": "<phone number type>", } ]`
`social_media_urls`	any[]	No	—	Social Media Urls
`source`	string	No	—	The source value
`title`	string	No	—	The candidate’s job title.
`website`	string	No	—	The website value
`work_history`	any[]	No	—	An array of work history objects. Each work history object should conform to the work history objects passed to the normal work history create endpoint [ { "title": "Engineer", "employer": { "linked": false, "name": "<employer name>", "location": { "city": "<employer city>", "state": "<employer state>" } }, "supervisor": { "linked": false, "name": "<supervisor name>", "phone": "<supervisor phone number>" }, "is_verified": true, "is_current": false, "start_date": "asdas", "end_date": "asd", "reason_for_leaving": "foo" } ]

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."
    },
    "address": {
      "type": "object",
      "description": "An object containing the address for the candidate with the following structure:  ``` {   \"street\": \"<street>\",   \"city\": \"<city>\",   \"state\": \"<state>\",   \"postal_code\": \"<postal code>\" } ```",
      "properties": {
        "street": {
          "type": "string",
          "description": "The street value"
        },
        "city": {
          "type": "string",
          "description": "The city value"
        },
        "state": {
          "type": "string",
          "description": "The state value"
        },
        "postal_code": {
          "type": "string",
          "description": "Postal Code"
        }
      }
    },
    "best_time_to_call": {
      "type": "string",
      "description": "Best Time To Call"
    },
    "country_code": {
      "type": "string",
      "description": "Country Code"
    },
    "current_employer": {
      "type": "string",
      "description": "Current Employer"
    },
    "current_pay": {
      "type": "string",
      "description": "Current Pay"
    },
    "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 candidate.  ``` [     {         \"id\": <custom field definition id>,         \"value\": \"<custom field value>\"     } ] ```"
    },
    "date_available": {
      "type": "string",
      "description": "The date the candidate is available for an opening."
    },
    "desired_pay": {
      "type": "string",
      "description": "Desired Pay"
    },
    "emails": {
      "type": "array",
      "description": "An array of email objects. Each email object should contain two keys: `email` and `is_primary`, as described [here](#candidates-create-an-email)  ``` [     {         \"email\": <email>,         \"is_primary\": \"<is this the primary email?>\"     } ] ```"
    },
    "first_name": {
      "type": "string",
      "description": "First Name"
    },
    "is_active": {
      "type": "boolean",
      "description": "A flag indicating if the candidate is active."
    },
    "is_hot": {
      "type": "boolean",
      "description": "A flag indicating if the candidate should be marked as hot. A hot candidate is highlighted in the candidates view."
    },
    "is_willing_to_relocate": {
      "type": "boolean",
      "description": "Is Willing To Relocate"
    },
    "key_skills": {
      "type": "string",
      "description": "Key Skills"
    },
    "last_name": {
      "type": "string",
      "description": "Last Name"
    },
    "middle_name": {
      "type": "string",
      "description": "Middle Name"
    },
    "notes": {
      "type": "string",
      "description": "The notes value"
    },
    "owner_id": {
      "type": "number",
      "description": "The user id of the record owner"
    },
    "password": {
      "type": "string",
      "description": "The candidate's password if they are \"registering\". Registered candidate can be authenticated with `/candidates/authorization`."
    },
    "phones": {
      "type": "array",
      "description": "An array of phone objects. Each phone object should contain three keys: `number`, `extension`, and `type`, as described [here](#candidates-create-a-phone)  ``` [     {         \"number\": <phone number with country code>,         \"extension\": \"<optional extension>\",         \"type\": \"<phone number type>\",     } ] ```"
    },
    "social_media_urls": {
      "type": "array",
      "description": "Social Media Urls"
    },
    "source": {
      "type": "string",
      "description": "The source value"
    },
    "title": {
      "type": "string",
      "description": "The candidate's job title."
    },
    "website": {
      "type": "string",
      "description": "The website value"
    },
    "work_history": {
      "type": "array",
      "description": "An array of work history objects. Each work history object should conform to the work history objects passed to the normal work history create endpoint  ``` [     {        \"title\": \"Engineer\",        \"employer\": {             \"linked\": false,             \"name\": \"<employer name>\",             \"location\": {                 \"city\": \"<employer city>\",                 \"state\": \"<employer state>\"             }        },        \"supervisor\": {             \"linked\": false,             \"name\": \"<supervisor name>\",             \"phone\": \"<supervisor phone number>\"        },        \"is_verified\": true,        \"is_current\": false,        \"start_date\": \"asdas\",        \"end_date\": \"asd\",        \"reason_for_leaving\": \"foo\"     } ] ```"
    }
  },
  "required": [
    "PCID",
    "check_duplicate",
    "first_name",
    "last_name"
  ]
}

cats_candidates_create_a_candidate_activity

Create a candidate activity Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate to create an activity for.
`date`	string	No	—	The datetime the activity took place. If not specified it defaults to the current date and time.
`notes`	string	No	—	The notes value
`regarding_id`	number	No	—	The ID of the job order that this activity is regarding. Leave `null` for a general activity.
`type`	string	Yes	—	One of the following activity types: `email`, `meeting`, `call_talked`, `call_lvm`, `call_missed`, `text_message` or `other`.

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 create an activity for."
    },
    "date": {
      "type": "string",
      "description": "The datetime the activity took place. If not specified it defaults to the current date and time."
    },
    "notes": {
      "type": "string",
      "description": "The notes value"
    },
    "regarding_id": {
      "type": "number",
      "description": "The ID of the job order that this activity is regarding. Leave `null` for a general activity."
    },
    "type": {
      "type": "string",
      "description": "One of the following activity types: `email`, `meeting`, `call_talked`, `call_lvm`, `call_missed`, `text_message` or `other`."
    }
  },
  "required": [
    "PCID",
    "id",
    "type"
  ]
}

cats_candidates_create_a_candidate_email

Create a candidate email Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The candidate to create the email for.
`email`	string	Yes	—	The email value
`is_primary`	boolean	No	—	If a record has any number of emails, exactly one of them must be marked as primary.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "candidate_id": {
      "type": "number",
      "description": "The candidate to create the email for."
    },
    "email": {
      "type": "string",
      "description": "The email value"
    },
    "is_primary": {
      "type": "boolean",
      "description": "If a record has any number of emails, exactly one of them must be marked as primary."
    }
  },
  "required": [
    "PCID",
    "candidate_id",
    "email"
  ]
}

cats_candidates_create_a_candidate_list

Create a candidate 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_candidates_create_a_candidate_phone

Create a candidate phone Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The candidate to create the phone for.
`extension`	string	No	—	The extension value
`number`	string	Yes	—	This number MUST begin with the country code. It will not be parsed correctly otherwise.
`type`	string	Yes	—	One of `mobile`, `home`, `work`, `fax`, `main`, or `other`.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "candidate_id": {
      "type": "number",
      "description": "The candidate to create the phone for."
    },
    "extension": {
      "type": "string",
      "description": "The extension value"
    },
    "number": {
      "type": "string",
      "description": "This number MUST begin with the country code. It will not be parsed correctly otherwise."
    },
    "type": {
      "type": "string",
      "description": "One of `mobile`, `home`, `work`, `fax`, `main`, or `other`."
    }
  },
  "required": [
    "PCID",
    "candidate_id",
    "number",
    "type"
  ]
}

cats_candidates_create_a_candidate_work_history_item

Create a candidate work history item Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate to create work history for.
`employer`	object	Yes	—	An object containing the employer information for a work history item with one of the following structures: `{ "linked": false, "name": "<employer name>", "location": { "city": "<employer city>", "state": "<employer state>" } }` or `{ "linked": true, "company_id": 465 }` Both `linked` and `name` are required fields within the first object, and `linked` and `company_id` are required in the second object.
`end_date`	string	No	—	End date for filtering
`is_current`	string	No	—	If this is set to `true`, both `end_date` and `reason_for_leaving` will be ignored.
`is_verified`	boolean	No	—	Is Verified
`reason_for_leaving`	string	No	—	Reason For Leaving
`start_date`	string	No	—	Start date for filtering
`supervisor`	object	No	—	An object containing the supervisor information for a work history item with one of the following structures: `{ "linked": false, "name": "<supervisor name>", "phone": "<supervisor phone number>" }` or `{ "linked": true, "contact_id": 6864 }`
`title`	string	Yes	—	The title 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 candidate to create work history for."
    },
    "employer": {
      "type": "object",
      "description": "An object containing the employer information for a work history item with one of the following structures:  ``` {   \"linked\": false,   \"name\": \"<employer name>\",   \"location\": {     \"city\": \"<employer city>\",     \"state\": \"<employer state>\"   } } ```  or  ``` {   \"linked\": true,   \"company_id\": 465 } ```  Both `linked` and `name` are required fields within the first object, and `linked` and `company_id` are required in the second object.",
      "properties": {
        "linked": {
          "type": "boolean",
          "description": "The linked value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "location": {
          "type": "object",
          "description": "The location value"
        }
      }
    },
    "end_date": {
      "type": "string",
      "description": "End date for filtering"
    },
    "is_current": {
      "type": "string",
      "description": "If this is set to `true`, both `end_date` and `reason_for_leaving` will be ignored."
    },
    "is_verified": {
      "type": "boolean",
      "description": "Is Verified"
    },
    "reason_for_leaving": {
      "type": "string",
      "description": "Reason For Leaving"
    },
    "start_date": {
      "type": "string",
      "description": "Start date for filtering"
    },
    "supervisor": {
      "type": "object",
      "description": "An object containing the supervisor information for a work history item with one of the following structures:  ``` {   \"linked\": false,   \"name\": \"<supervisor name>\",   \"phone\": \"<supervisor phone number>\" } ```  or  ``` {   \"linked\": true,   \"contact_id\": 6864 } ```",
      "properties": {
        "linked": {
          "type": "boolean",
          "description": "The linked value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "phone": {
          "type": "string",
          "description": "The phone value"
        }
      }
    },
    "title": {
      "type": "string",
      "description": "The title value"
    }
  },
  "required": [
    "PCID",
    "id",
    "employer",
    "title"
  ]
}

cats_candidates_create_candidate_list_items

Create candidate list items Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate 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 candidate list."
    },
    "items": {
      "type": "array",
      "description": "The items value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_candidates_delete_a_candidate

Delete a candidate Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate 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 candidate to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_candidates_delete_a_candidate_email

Delete a candidate email Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The candidate to delete the email from.
`id`	number	Yes	—	The ID of the email to delete.

Show inputSchema

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

cats_candidates_delete_a_candidate_list

Delete a candidate list Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate 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 candidate list to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_candidates_delete_a_candidate_list_item

Delete a candidate list item Parameters:

Parameter	Type	Required	Default	Description
`list_id`	number	Yes	—	The ID of the candidate 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 candidate list."
    },
    "item_id": {
      "type": "number",
      "description": "The ID of the list item to delete."
    }
  },
  "required": [
    "PCID",
    "list_id",
    "item_id"
  ]
}

cats_candidates_delete_a_candidate_phone

Delete a candidate phone Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The candidate to delete the phone from.
`id`	number	Yes	—	The ID of the phone to delete.

Show inputSchema

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

cats_candidates_delete_a_candidate_work_history_item

Delete a candidate work history item Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the work history 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 work history to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_candidates_delete_candidate_tag

Delete candidate tag Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The ID of the candidate 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"
    },
    "candidate_id": {
      "type": "number",
      "description": "The ID of the candidate to detach the tag from."
    },
    "tag_id": {
      "type": "number",
      "description": "The ID of the tag to detach."
    }
  },
  "required": [
    "PCID",
    "candidate_id",
    "tag_id"
  ]
}

cats_candidates_filter_candidates

Filter candidates Parameters:

Parameter	Type	Required	Default	Description
`query`	string	Yes	—	The optional string to search within candidates for.
`page`	number	Yes	—	The current page number of candidates to return.
`per_page`	number	Yes	—	The number of candidates 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 candidates for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of candidates to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of candidates 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_candidates_get_a_candidate

Get a candidate Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate 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 candidate to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_candidates_get_a_candidate_application

Get a candidate application Parameters:

Parameter	Type	Required	Default	Description
`application_id`	number	Yes	—	The ID of the applications to return.
`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"
    },
    "application_id": {
      "type": "number",
      "description": "The ID of the applications to return."
    },
    "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",
    "application_id",
    "page",
    "per_page"
  ]
}

cats_candidates_get_a_candidate_custom_field

Get a candidate 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_candidates_get_a_candidate_custom_field_value

Get a candidate custom field value Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The ID of the candidate 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"
    },
    "candidate_id": {
      "type": "number",
      "description": "The ID of the candidate that the custom field belongs to."
    },
    "custom_field_id": {
      "type": "number",
      "description": "The ID of the custom field to return."
    }
  },
  "required": [
    "PCID",
    "candidate_id",
    "custom_field_id"
  ]
}

cats_candidates_get_a_candidate_email

Get a candidate email Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The candidate to return the email for.
`id`	number	Yes	—	The ID of the email to return.

Show inputSchema

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

cats_candidates_get_a_candidate_list

Get a candidate list Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate 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 candidate list to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_candidates_get_a_candidate_list_item

Get a candidate list item Parameters:

Parameter	Type	Required	Default	Description
`list_id`	number	Yes	—	The ID of the candidate list the item belongs to.
`item_id`	number	Yes	—	The ID of the candidate 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 candidate list the item belongs to."
    },
    "item_id": {
      "type": "number",
      "description": "The ID of the candidate list item to return."
    }
  },
  "required": [
    "PCID",
    "list_id",
    "item_id"
  ]
}

cats_candidates_get_a_candidate_phone

Get a candidate phone Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The candidate to return the phone for.
`id`	number	Yes	—	The ID of the phone to return.

Show inputSchema

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

cats_candidates_get_a_candidate_thumbnail

Get a candidate thumbnail Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate to get the thumbnail of.

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 get the thumbnail of."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_candidates_get_a_candidate_work_history_item

Get a candidate work history item Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the work history 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 work history to return."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_candidates_list_a_candidate_attachments

List a candidate 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_candidates_list_all_candidate_list_items

List all candidate list items Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate 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 candidate 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_candidates_list_all_candidate_lists

List all candidate 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_candidates_list_all_candidate_tags

List all candidate tags Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The ID of the candidate 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"
    },
    "candidate_id": {
      "type": "number",
      "description": "The ID of the candidate 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",
    "candidate_id",
    "page",
    "per_page"
  ]
}

cats_candidates_list_all_candidates

List all candidates Parameters:

Parameter	Type	Required	Default	Description
`page`	number	Yes	—	The current page number of candidates to return.
`per_page`	number	Yes	—	The number of candidates 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 candidates to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of candidates to return per page."
    }
  },
  "required": [
    "PCID",
    "page",
    "per_page"
  ]
}

cats_candidates_list_applications_by_candidate

List applications by candidate Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The ID of the candidate to return applications 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"
    },
    "candidate_id": {
      "type": "number",
      "description": "The ID of the candidate to return applications 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",
    "candidate_id",
    "page",
    "per_page"
  ]
}

cats_candidates_list_candidate_activities

List candidate activities Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate to return activities for.
`page`	number	Yes	—	The current page number of activities to return.
`per_page`	number	Yes	—	The number of activities 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 activities for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of activities to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of activities to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

cats_candidates_list_candidate_custom_field_values

List candidate custom field values Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate 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 candidate 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_candidates_list_candidate_custom_fields

List candidate 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_candidates_list_candidate_emails

List candidate emails Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The candidate to return emails for.
`page`	number	Yes	—	The current page number of emails to return.
`per_page`	number	Yes	—	The number of emails to return per page.

Show inputSchema

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

cats_candidates_list_candidate_phones

List candidate phones Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The candidate to return phones for.
`page`	number	Yes	—	The current page number of phones to return.
`per_page`	number	Yes	—	The number of phones to return per page.

Show inputSchema

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

cats_candidates_list_candidate_tasks

List candidate tasks Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate 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 candidate 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_candidates_list_candidate_work_history

List candidate work history Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate to fetch work history for.
`page`	number	Yes	—	The current page number of work history to return.
`per_page`	number	Yes	—	The number of work history 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 candidate to fetch work history for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of work history to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of work history items to return per page."
    }
  },
  "required": [
    "PCID",
    "id",
    "page",
    "per_page"
  ]
}

cats_candidates_list_pipelines_by_candidate

List pipelines by candidate Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate 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 candidate 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_candidates_replace_candidate_tags

Replace candidate tags Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The ID of the candidate 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"
    },
    "candidate_id": {
      "type": "number",
      "description": "The ID of the candidate to replace tags on."
    },
    "tags": {
      "type": "array",
      "description": "The tags value"
    }
  },
  "required": [
    "PCID",
    "candidate_id"
  ]
}

cats_candidates_search_candidates

Search candidates Parameters:

Parameter	Type	Required	Default	Description
`query`	string	Yes	—	The string to search within candidates for.
`page`	number	Yes	—	The current page number of candidates to return.
`per_page`	number	Yes	—	The number of candidates 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 candidates for."
    },
    "page": {
      "type": "number",
      "description": "The current page number of candidates to return."
    },
    "per_page": {
      "type": "number",
      "description": "The number of candidates to return per page."
    }
  },
  "required": [
    "PCID",
    "query",
    "page",
    "per_page"
  ]
}

cats_candidates_update_a_candidate

Update a candidate Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate to update.
`address`	object	No	—	An object containing the address for the candidate with the following structure: `{ "street": "<street>", "city": "<city>", "state": "<state>", "postal_code": "<postal code>" }`
`best_time_to_call`	string	No	—	Best Time To Call
`country_code`	string	No	—	Country Code
`current_employer`	string	No	—	Current Employer
`current_pay`	string	No	—	Current Pay
`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 candidate. `[ { "id": <custom field definition id>, "value": "<custom field value>" } ]`
`date_available`	string	No	—	The date the candidate is available for an opening.
`desired_pay`	string	No	—	Desired Pay
`first_name`	string	No	—	First Name
`is_active`	boolean	No	—	A flag indicating if the candidate is active.
`is_hot`	boolean	No	—	A flag indicating if the candidate should be marked as hot. A hot candidate is highlighted in the candidates view.
`is_willing_to_relocate`	boolean	No	—	Is Willing To Relocate
`key_skills`	string	No	—	Key Skills
`last_name`	string	No	—	Last Name
`middle_name`	string	No	—	Middle Name
`notes`	string	No	—	The notes value
`owner_id`	number	No	—	The user id of the record owner
`password`	string	No	—	The candidate’s password if they are “registering”. Registered candidate can be authenticated with `/candidates/authorization`.
`social_media_urls`	any[]	No	—	Social Media Urls
`source`	string	No	—	The source value
`title`	string	No	—	The candidate’s job title.
`website`	string	No	—	The website 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 candidate to update."
    },
    "address": {
      "type": "object",
      "description": "An object containing the address for the candidate with the following structure:  ``` {   \"street\": \"<street>\",   \"city\": \"<city>\",   \"state\": \"<state>\",   \"postal_code\": \"<postal code>\" } ```",
      "properties": {
        "street": {
          "type": "string",
          "description": "The street value"
        },
        "city": {
          "type": "string",
          "description": "The city value"
        },
        "state": {
          "type": "string",
          "description": "The state value"
        },
        "postal_code": {
          "type": "string",
          "description": "Postal Code"
        }
      }
    },
    "best_time_to_call": {
      "type": "string",
      "description": "Best Time To Call"
    },
    "country_code": {
      "type": "string",
      "description": "Country Code"
    },
    "current_employer": {
      "type": "string",
      "description": "Current Employer"
    },
    "current_pay": {
      "type": "string",
      "description": "Current Pay"
    },
    "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 candidate.  ``` [     {         \"id\": <custom field definition id>,         \"value\": \"<custom field value>\"     } ] ```"
    },
    "date_available": {
      "type": "string",
      "description": "The date the candidate is available for an opening."
    },
    "desired_pay": {
      "type": "string",
      "description": "Desired Pay"
    },
    "first_name": {
      "type": "string",
      "description": "First Name"
    },
    "is_active": {
      "type": "boolean",
      "description": "A flag indicating if the candidate is active."
    },
    "is_hot": {
      "type": "boolean",
      "description": "A flag indicating if the candidate should be marked as hot. A hot candidate is highlighted in the candidates view."
    },
    "is_willing_to_relocate": {
      "type": "boolean",
      "description": "Is Willing To Relocate"
    },
    "key_skills": {
      "type": "string",
      "description": "Key Skills"
    },
    "last_name": {
      "type": "string",
      "description": "Last Name"
    },
    "middle_name": {
      "type": "string",
      "description": "Middle Name"
    },
    "notes": {
      "type": "string",
      "description": "The notes value"
    },
    "owner_id": {
      "type": "number",
      "description": "The user id of the record owner"
    },
    "password": {
      "type": "string",
      "description": "The candidate's password if they are \"registering\". Registered candidate can be authenticated with `/candidates/authorization`."
    },
    "social_media_urls": {
      "type": "array",
      "description": "Social Media Urls"
    },
    "source": {
      "type": "string",
      "description": "The source value"
    },
    "title": {
      "type": "string",
      "description": "The candidate's job title."
    },
    "website": {
      "type": "string",
      "description": "The website value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_candidates_update_a_candidate_custom_field

Update a candidate custom field Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The ID of the candidate 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"
    },
    "candidate_id": {
      "type": "number",
      "description": "The ID of the candidate 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",
    "candidate_id",
    "custom_field_id"
  ]
}

cats_candidates_update_a_candidate_email

Update a candidate email Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The candidate to update the email for.
`id`	number	Yes	—	The ID of the email to update.
`email`	string	No	—	The email value
`is_primary`	boolean	No	—	If a record has any number of emails, exactly one of them must be marked as primary.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "candidate_id": {
      "type": "number",
      "description": "The candidate to update the email for."
    },
    "id": {
      "type": "number",
      "description": "The ID of the email to update."
    },
    "email": {
      "type": "string",
      "description": "The email value"
    },
    "is_primary": {
      "type": "boolean",
      "description": "If a record has any number of emails, exactly one of them must be marked as primary."
    }
  },
  "required": [
    "PCID",
    "candidate_id",
    "id"
  ]
}

cats_candidates_update_a_candidate_phone

Update a candidate phone Parameters:

Parameter	Type	Required	Default	Description
`candidate_id`	number	Yes	—	The candidate to update the phone for.
`id`	number	Yes	—	The ID of the phone to update.
`extension`	string	No	—	The extension value
`number`	string	No	—	This number MUST begin with the country code. It will not be parsed correctly otherwise.
`type`	string	No	—	One of `mobile`, `home`, `work`, `fax`, `main`, or `other`.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "candidate_id": {
      "type": "number",
      "description": "The candidate to update the phone for."
    },
    "id": {
      "type": "number",
      "description": "The ID of the phone to update."
    },
    "extension": {
      "type": "string",
      "description": "The extension value"
    },
    "number": {
      "type": "string",
      "description": "This number MUST begin with the country code. It will not be parsed correctly otherwise."
    },
    "type": {
      "type": "string",
      "description": "One of `mobile`, `home`, `work`, `fax`, `main`, or `other`."
    }
  },
  "required": [
    "PCID",
    "candidate_id",
    "id"
  ]
}

cats_candidates_update_a_candidate_work_history_item

Update a candidate work history item Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the work history to update.
`employer`	object	No	—	An object containing the employer information for a work history item with one of the following structures: `{ "linked": false, "name": "<employer name>", "location": { "city": "<employer city>", "state": "<employer state>" } }` or `{ "linked": true, "company_id": 465 }` Both `linked` and `name` are required fields within the first object, and `linked` and `company_id` are required in the second object.
`end_date`	string	No	—	End date for filtering
`is_current`	string	No	—	If this is set to `true`, both `end_date` and `reason_for_leaving` will be ignored.
`is_verified`	boolean	No	—	Is Verified
`reason_for_leaving`	string	No	—	Reason For Leaving
`start_date`	string	No	—	Start date for filtering
`supervisor`	object	No	—	An object containing the supervisor information for a work history item with one of the following structures: `{ "linked": false, "name": "<supervisor name>", "phone": "<supervisor phone number>" }` or `{ "linked": true, "contact_id": 6864 }`
`title`	string	No	—	The title 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 work history to update."
    },
    "employer": {
      "type": "object",
      "description": "An object containing the employer information for a work history item with one of the following structures:  ``` {   \"linked\": false,   \"name\": \"<employer name>\",   \"location\": {     \"city\": \"<employer city>\",     \"state\": \"<employer state>\"   } } ```  or  ``` {   \"linked\": true,   \"company_id\": 465 } ```  Both `linked` and `name` are required fields within the first object, and `linked` and `company_id` are required in the second object.",
      "properties": {
        "linked": {
          "type": "boolean",
          "description": "The linked value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "location": {
          "type": "object",
          "description": "The location value"
        }
      }
    },
    "end_date": {
      "type": "string",
      "description": "End date for filtering"
    },
    "is_current": {
      "type": "string",
      "description": "If this is set to `true`, both `end_date` and `reason_for_leaving` will be ignored."
    },
    "is_verified": {
      "type": "boolean",
      "description": "Is Verified"
    },
    "reason_for_leaving": {
      "type": "string",
      "description": "Reason For Leaving"
    },
    "start_date": {
      "type": "string",
      "description": "Start date for filtering"
    },
    "supervisor": {
      "type": "object",
      "description": "An object containing the supervisor information for a work history item with one of the following structures:  ``` {   \"linked\": false,   \"name\": \"<supervisor name>\",   \"phone\": \"<supervisor phone number>\" } ```  or  ``` {   \"linked\": true,   \"contact_id\": 6864 } ```",
      "properties": {
        "linked": {
          "type": "boolean",
          "description": "The linked value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "phone": {
          "type": "string",
          "description": "The phone value"
        }
      }
    },
    "title": {
      "type": "string",
      "description": "The title value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_candidates_upload_a_candidate_attachment

Upload a candidate attachment Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate 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 candidate that the attachment is being attached to."
    },
    "filename": {
      "type": "string",
      "description": "The name to save the file being uploaded as."
    }
  },
  "required": [
    "PCID",
    "id",
    "filename"
  ]
}

cats_candidates_upload_a_resume

Upload a resume Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the candidate that the resume 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 candidate that the resume is being attached to."
    },
    "filename": {
      "type": "string",
      "description": "The name to save the file being uploaded as."
    }
  },
  "required": [
    "PCID",
    "id",
    "filename"
  ]
}

cats-admin cats-companies

⌘I

​Tools

​cats_candidates_attach_candidate_tags

​cats_candidates_authorize_a_candidate

​cats_candidates_change_a_candidate_thumbnail

​cats_candidates_create_a_candidate

​cats_candidates_create_a_candidate_activity

​cats_candidates_create_a_candidate_email

​cats_candidates_create_a_candidate_list

​cats_candidates_create_a_candidate_phone

​cats_candidates_create_a_candidate_work_history_item

​cats_candidates_create_candidate_list_items

​cats_candidates_delete_a_candidate

​cats_candidates_delete_a_candidate_email

​cats_candidates_delete_a_candidate_list

​cats_candidates_delete_a_candidate_list_item

​cats_candidates_delete_a_candidate_phone

​cats_candidates_delete_a_candidate_work_history_item

​cats_candidates_delete_candidate_tag

​cats_candidates_filter_candidates

​cats_candidates_get_a_candidate

​cats_candidates_get_a_candidate_application

​cats_candidates_get_a_candidate_custom_field

​cats_candidates_get_a_candidate_custom_field_value

​cats_candidates_get_a_candidate_email

​cats_candidates_get_a_candidate_list

​cats_candidates_get_a_candidate_list_item

​cats_candidates_get_a_candidate_phone

​cats_candidates_get_a_candidate_thumbnail

​cats_candidates_get_a_candidate_work_history_item

​cats_candidates_list_a_candidate_attachments

​cats_candidates_list_all_candidate_list_items

​cats_candidates_list_all_candidate_lists

​cats_candidates_list_all_candidate_tags

​cats_candidates_list_all_candidates

​cats_candidates_list_applications_by_candidate

​cats_candidates_list_candidate_activities

​cats_candidates_list_candidate_custom_field_values

​cats_candidates_list_candidate_custom_fields

​cats_candidates_list_candidate_emails

​cats_candidates_list_candidate_phones

​cats_candidates_list_candidate_tasks

​cats_candidates_list_candidate_work_history

​cats_candidates_list_pipelines_by_candidate

​cats_candidates_replace_candidate_tags

​cats_candidates_search_candidates

​cats_candidates_update_a_candidate

​cats_candidates_update_a_candidate_custom_field

​cats_candidates_update_a_candidate_email

​cats_candidates_update_a_candidate_phone

​cats_candidates_update_a_candidate_work_history_item

​cats_candidates_upload_a_candidate_attachment

​cats_candidates_upload_a_resume

Tools

cats_candidates_attach_candidate_tags

cats_candidates_authorize_a_candidate

cats_candidates_change_a_candidate_thumbnail

cats_candidates_create_a_candidate

cats_candidates_create_a_candidate_activity

cats_candidates_create_a_candidate_email

cats_candidates_create_a_candidate_list

cats_candidates_create_a_candidate_phone

cats_candidates_create_a_candidate_work_history_item

cats_candidates_create_candidate_list_items

cats_candidates_delete_a_candidate

cats_candidates_delete_a_candidate_email

cats_candidates_delete_a_candidate_list

cats_candidates_delete_a_candidate_list_item

cats_candidates_delete_a_candidate_phone

cats_candidates_delete_a_candidate_work_history_item

cats_candidates_delete_candidate_tag

cats_candidates_filter_candidates

cats_candidates_get_a_candidate

cats_candidates_get_a_candidate_application

cats_candidates_get_a_candidate_custom_field

cats_candidates_get_a_candidate_custom_field_value

cats_candidates_get_a_candidate_email

cats_candidates_get_a_candidate_list

cats_candidates_get_a_candidate_list_item

cats_candidates_get_a_candidate_phone

cats_candidates_get_a_candidate_thumbnail

cats_candidates_get_a_candidate_work_history_item

cats_candidates_list_a_candidate_attachments

cats_candidates_list_all_candidate_list_items

cats_candidates_list_all_candidate_lists

cats_candidates_list_all_candidate_tags

cats_candidates_list_all_candidates

cats_candidates_list_applications_by_candidate

cats_candidates_list_candidate_activities

cats_candidates_list_candidate_custom_field_values

cats_candidates_list_candidate_custom_fields

cats_candidates_list_candidate_emails

cats_candidates_list_candidate_phones

cats_candidates_list_candidate_tasks

cats_candidates_list_candidate_work_history

cats_candidates_list_pipelines_by_candidate

cats_candidates_replace_candidate_tags

cats_candidates_search_candidates

cats_candidates_update_a_candidate

cats_candidates_update_a_candidate_custom_field

cats_candidates_update_a_candidate_email

cats_candidates_update_a_candidate_phone

cats_candidates_update_a_candidate_work_history_item

cats_candidates_upload_a_candidate_attachment

cats_candidates_upload_a_resume