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

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

Tools

Tool	Description
`cats_admin_create_a_backup`	Create a backup
`cats_admin_create_a_task`	Create a task
`cats_admin_create_a_webhook`	Create a webhook
`cats_admin_delete_a_task`	Delete a task
`cats_admin_delete_a_webhook`	Delete a webhook
`cats_admin_delete_a_work_history`	Delete a work history
`cats_admin_delete_an_activity`	Delete an activity
`cats_admin_delete_an_attachment`	Delete an attachment
`cats_admin_download_an_attachment`	Download an attachment
`cats_admin_filter_activities`	Filter activities
`cats_admin_get_a_backup`	Get a backup
`cats_admin_get_a_portal`	Get a portal
`cats_admin_get_a_tag`	Get a tag
`cats_admin_get_a_task`	Get a task
`cats_admin_get_a_trigger`	Get a trigger
`cats_admin_get_a_user`	Get a user
`cats_admin_get_a_webhook`	Get a webhook
`cats_admin_get_a_work_history`	Get a work history
`cats_admin_get_an_activity`	Get an activity
`cats_admin_get_an_attachment`	Get an attachment
`cats_admin_get_portal_registration_application`	Get portal registration application
`cats_admin_get_site`	Get site
`cats_admin_list_all_activities`	List all activities
`cats_admin_list_all_backups`	List all backups
`cats_admin_list_all_events_starting_after_a_timestamp`	List all events starting after a timestamp
`cats_admin_list_all_portals`	List all portals
`cats_admin_list_all_tags`	List all tags
`cats_admin_list_all_tasks`	List all tasks
`cats_admin_list_all_triggers`	List all triggers
`cats_admin_list_all_users`	List all users
`cats_admin_list_all_webhooks`	List all webhooks
`cats_admin_list_portal_jobs`	List portal jobs
`cats_admin_parse_a_resume`	Parse a resume
`cats_admin_publish_portal_job`	Publish portal job
`cats_admin_search_activities`	Search activities
`cats_admin_submit`	Submit
`cats_admin_submit_portal_registration_application`	Submit portal registration application
`cats_admin_unpublish_portal_job`	Unpublish portal job
`cats_admin_update_a_task`	Update a task
`cats_admin_update_a_work_history`	Update a work history
`cats_admin_update_an_activity`	Update an activity

cats_admin_create_a_backup

Create a backup Parameters:

Parameter	Type	Required	Default	Description
`include_attachments`	boolean	No	—	Whether to include attachments in the backup or not. Running a backup without attachments can greatly speed up the backup time. Defaults to false.
`include_emails`	boolean	No	—	Whether to include emails in the backup or not. Running a backup without emails can greatly speed up the backup time. Defaults to true.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "include_attachments": {
      "type": "boolean",
      "description": "Whether to include attachments in the backup or not. Running a backup without attachments can greatly speed up the backup time. Defaults to false."
    },
    "include_emails": {
      "type": "boolean",
      "description": "Whether to include emails in the backup or not. Running a backup without emails can greatly speed up the backup time. Defaults to true."
    }
  },
  "required": [
    "PCID"
  ]
}

cats_admin_create_a_task

Create a task Parameters:

Parameter	Type	Required	Default	Description
`assigned_to_id`	number	No	—	The user to assign the task to
`data_item`	object	No	—	A DataItem the object is about, or null for a general task
`date_due`	string	No	—	If null the task will be assigned ASAP as in the CATS UI
`description`	string	No	—	The description value
`priority`	number	No	—	A number 1-5, with 1 being the lowest priority

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assigned_to_id": {
      "type": "number",
      "description": "The user to assign the task to"
    },
    "data_item": {
      "type": "object",
      "description": "A DataItem the object is about, or null for a general task",
      "properties": {
        "id": {
          "type": "number",
          "description": "The id value"
        },
        "type": {
          "type": "string",
          "description": "The type value"
        }
      }
    },
    "date_due": {
      "type": "string",
      "description": "If null the task will be assigned ASAP as in the CATS UI"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "priority": {
      "type": "number",
      "description": "A number 1-5, with 1 being the lowest priority"
    }
  },
  "required": [
    "PCID"
  ]
}

cats_admin_create_a_webhook

Create a webhook Parameters:

Parameter	Type	Required	Default	Description
`events`	any[]	Yes	—	An array of one or more of the following event types: `candidate.created`, `job.created`, `contact.created`, `company.created`, `activity.created`, `user.created`, `pipeline.created`, `candidate.updated`, `job.updated`, `contact.updated`, `company.updated`, `activity.updated`, `user.updated`, `candidate.deleted`, `job.deleted`, `contact.deleted`, `company.deleted`, `activity.deleted`, `user.deleted`, `pipeline.deleted`, `job.status_changed`, `contact.status_changed`, `company.status_changed`, `pipeline.status_changed`
`secret`	string	No	—	Highly Recommended. If provided, you can use this string to verify that authenticity of webhooks sent to `target_url`. All webhooks you subscribe to you will send a `X-Signature` header. To determine whether the `X-Signature` header is valid take the body of the webhook response, append the value of the `X-Request-Id` header to it, and then generate a `HMAC-SHA256` hash of it using your secret as a key. That final result should match the hash found in the `X-Signature` header. Here are two examples of the verification process in PHP and Python 3: PHP $secret = 'yourSecretHere'; $webhookBody = '{}'; // `X-Request-Id` header $requestId = '5d6ce3f9-cce8-4b5b-a26e-396a6161eb99'; // `X-Signature` header $signature = 'HMAC-SHA256 affc8d589f36580daa0d587ac0b314c123b59322cf4d018661e0a403cc76391f'; $hash = hash_hmac('sha256', $requestBody . $requestId, $secret, false); if ($signature !== 'HMAC-SHA256 ' . $hash) { // Reject it }
`target_url`	string	Yes	—	URL to post the record to once the event is triggered.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "events": {
      "type": "array",
      "description": "An array of one or more of the following event types: `candidate.created`, `job.created`, `contact.created`, `company.created`, `activity.created`, `user.created`, `pipeline.created`, `candidate.updated`, `job.updated`, `contact.updated`, `company.updated`, `activity.updated`, `user.updated`, `candidate.deleted`, `job.deleted`, `contact.deleted`, `company.deleted`, `activity.deleted`, `user.deleted`, `pipeline.deleted`, `job.status_changed`, `contact.status_changed`, `company.status_changed`, `pipeline.status_changed`"
    },
    "secret": {
      "type": "string",
      "description": "***Highly Recommended***. If provided, you can use this string to verify that authenticity of webhooks sent to `target_url`. All webhooks you subscribe to you will send a `X-Signature` header. To determine whether the `X-Signature` header is valid take the body of the webhook response, append the value of the `X-Request-Id` header to it, and then generate a `HMAC-SHA256` hash of it using your secret as a key. That final result should match the hash found in the `X-Signature` header. Here are two examples of the verification process in PHP and Python 3:  ```PHP $secret = 'yourSecretHere'; $webhookBody = '{}';  // `X-Request-Id` header $requestId = '5d6ce3f9-cce8-4b5b-a26e-396a6161eb99';  // `X-Signature` header $signature = 'HMAC-SHA256 affc8d589f36580daa0d587ac0b314c123b59322cf4d018661e0a403cc76391f';  $hash = hash_hmac('sha256', $requestBody . $requestId, $secret, false);  if ($signature !== 'HMAC-SHA256 ' . $hash) {     // Reject it } ```"
    },
    "target_url": {
      "type": "string",
      "description": "URL to post the record to once the event is triggered."
    }
  },
  "required": [
    "PCID",
    "events",
    "target_url"
  ]
}

cats_admin_delete_a_task

Delete a task Parameters:

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

cats_admin_delete_a_webhook

Delete a webhook Parameters:

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

cats_admin_delete_a_work_history

Delete a work history Parameters:

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

cats_admin_delete_an_activity

Delete an activity Parameters:

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

cats_admin_delete_an_attachment

Delete an attachment Parameters:

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

cats_admin_download_an_attachment

Download an attachment Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the attachment to download.

Show inputSchema

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

cats_admin_filter_activities

Filter activities Parameters:

Parameter	Type	Required	Default	Description
`query`	string	Yes	—	The optional string to search within 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.
`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 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."
    },
    "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_admin_get_a_backup

Get a backup Parameters:

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

cats_admin_get_a_portal

Get a portal Parameters:

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

cats_admin_get_a_tag

Get a tag Parameters:

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

cats_admin_get_a_task

Get a task Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The ID of the task to return.

Show inputSchema

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

cats_admin_get_a_trigger

Get a trigger Parameters:

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

cats_admin_get_a_user

Get a user Parameters:

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

cats_admin_get_a_webhook

Get a webhook Parameters:

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

cats_admin_get_a_work_history

Get a work history Parameters:

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

cats_admin_get_an_activity

Get an activity Parameters:

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

cats_admin_get_an_attachment

Get an attachment Parameters:

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

cats_admin_get_portal_registration_application

Get portal registration application Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the portal to return registration application for.

Show inputSchema

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

cats_admin_get_site

Get site

Show inputSchema

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

cats_admin_list_all_activities

List all activities Parameters:

Parameter	Type	Required	Default	Description
`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"
    },
    "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",
    "page",
    "per_page"
  ]
}

cats_admin_list_all_backups

List all backups Parameters:

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

cats_admin_list_all_events_starting_after_a_timestamp

List all events starting after a timestamp Parameters:

Parameter	Type	Required	Default	Description
`starting_after_timestamp`	number	Yes	—	Get up to 25 events immediately following (but not including) this timestamp

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "starting_after_timestamp": {
      "type": "number",
      "description": "Get up to 25 events immediately following (but not including) this timestamp"
    }
  },
  "required": [
    "PCID",
    "starting_after_timestamp"
  ]
}

cats_admin_list_all_portals

List all portals Parameters:

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

cats_admin_list_all_tags

List all tags Parameters:

Parameter	Type	Required	Default	Description
`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"
    },
    "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",
    "page",
    "per_page"
  ]
}

cats_admin_list_all_tasks

List all tasks Parameters:

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

cats_admin_list_all_triggers

List all triggers Parameters:

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

cats_admin_list_all_users

List all users Parameters:

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

cats_admin_list_all_webhooks

List all webhooks Parameters:

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

cats_admin_list_portal_jobs

List portal jobs Parameters:

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

cats_admin_parse_a_resume

Parse a resume

Show inputSchema

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

cats_admin_publish_portal_job

Publish portal job Parameters:

Parameter	Type	Required	Default	Description
`portal_id`	number	Yes	—	The ID of the portal the job being submitted to is on.
`job_id`	number	Yes	—	The ID of the job the application is being submitted for.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "portal_id": {
      "type": "number",
      "description": "The ID of the portal the job being submitted to is on."
    },
    "job_id": {
      "type": "number",
      "description": "The ID of the job the application is being submitted for."
    }
  },
  "required": [
    "PCID",
    "portal_id",
    "job_id"
  ]
}

cats_admin_search_activities

Search activities Parameters:

Parameter	Type	Required	Default	Description
`query`	string	Yes	—	The string to search within 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"
    },
    "query": {
      "type": "string",
      "description": "The string to search within 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",
    "query",
    "page",
    "per_page"
  ]
}

cats_admin_submit

Submit Parameters:

Parameter	Type	Required	Default	Description
`portal_id`	number	Yes	—	The ID of the portal the job being submitted to is on.
`job_id`	number	Yes	—	The ID of the job the application is being submitted for.
`fields`	any[]	No	—	An example with all fields types: { "fields": [ { /* file / "id": 523423, "value": "SGVsbG8gV29ybGQ=", "filename": "helloworld.txt" }, { / text / "id": 523591, "value": "James" }, { / multiline / "id": 524022 "value": "line 1\r\nline 2" }, { / checkbox / "id": 524156 "value": true }, { / checkboxes / "id": 524221 "value": { "3251": true, "3991": true } }, { / radio/select */ "id": 524221 "value": { "4126": true } } ], "source": "Google" }
`source`	string	No	—	If the applicant is brand new to the system, what you provide in the source field will be set as their source. If they are not new to the system, their existing source will NOT be overwritten. If source is not provided it defaults to “Career Portal”.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "portal_id": {
      "type": "number",
      "description": "The ID of the portal the job being submitted to is on."
    },
    "job_id": {
      "type": "number",
      "description": "The ID of the job the application is being submitted for."
    },
    "fields": {
      "type": "array",
      "description": "An example with all fields types:  ``` {     \"fields\": [         {             /* file */             \"id\": 523423,             \"value\": \"SGVsbG8gV29ybGQ=\",             \"filename\": \"helloworld.txt\"         },         {             /* text */             \"id\": 523591,             \"value\": \"James\"         },         {             /* multiline */             \"id\": 524022             \"value\": \"line 1\\r\\nline 2\"         },         {             /* checkbox */             \"id\": 524156             \"value\": true         },         {             /* checkboxes */             \"id\": 524221             \"value\": {                 \"3251\": true,                 \"3991\": true             }         },         {             /* radio/select */             \"id\": 524221             \"value\": {                 \"4126\": true             }         }     ],     \"source\": \"Google\" } ```"
    },
    "source": {
      "type": "string",
      "description": "If the applicant is brand new to the system, what you provide in the source field will be set as their source. If they are not new to the system, their existing source will *NOT* be overwritten. If source is not provided it defaults to \"Career Portal\"."
    }
  },
  "required": [
    "PCID",
    "portal_id",
    "job_id"
  ]
}

cats_admin_submit_portal_registration_application

Submit portal registration application Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the portal being submitted to.
`fields`	any[]	No	—	An example with all fields types: { "fields": [ { /* file / "id": 523423, "value": "SGVsbG8gV29ybGQ=", "filename": "helloworld.txt" }, { / text / "id": 523591, "value": "James" }, { / multiline / "id": 524022 "value": "line 1\r\nline 2" }, { / checkbox / "id": 524156 "value": true }, { / checkboxes / "id": 524221 "value": { "3251": true, "3991": true } }, { / radio/select */ "id": 524221 "value": { "4126": true } } ], "source": "Google" }
`source`	string	No	—	If the applicant is brand new to the system, what you provide in the source field will be set as their source. If they are not new to the system, their existing source will NOT be overwritten. If source is not provided it defaults to “Career Portal”.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the portal being submitted to."
    },
    "fields": {
      "type": "array",
      "description": "An example with all fields types:  ``` {     \"fields\": [         {             /* file */             \"id\": 523423,             \"value\": \"SGVsbG8gV29ybGQ=\",             \"filename\": \"helloworld.txt\"         },         {             /* text */             \"id\": 523591,             \"value\": \"James\"         },         {             /* multiline */             \"id\": 524022             \"value\": \"line 1\\r\\nline 2\"         },         {             /* checkbox */             \"id\": 524156             \"value\": true         },         {             /* checkboxes */             \"id\": 524221             \"value\": {                 \"3251\": true,                 \"3991\": true             }         },         {             /* radio/select */             \"id\": 524221             \"value\": {                 \"4126\": true             }         }     ],     \"source\": \"Google\" } ```"
    },
    "source": {
      "type": "string",
      "description": "If the applicant is brand new to the system, what you provide in the source field will be set as their source. If they are not new to the system, their existing source will *NOT* be overwritten. If source is not provided it defaults to \"Career Portal\"."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_admin_unpublish_portal_job

Unpublish portal job Parameters:

Parameter	Type	Required	Default	Description
`portal_id`	number	Yes	—	The ID of the portal the job being submitted to is on.
`job_id`	number	Yes	—	The ID of the job the application is being submitted for.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "portal_id": {
      "type": "number",
      "description": "The ID of the portal the job being submitted to is on."
    },
    "job_id": {
      "type": "number",
      "description": "The ID of the job the application is being submitted for."
    }
  },
  "required": [
    "PCID",
    "portal_id",
    "job_id"
  ]
}

cats_admin_update_a_task

Update a task Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the task to update.
`assigned_to_id`	number	No	—	The user to assign the task to
`date_due`	string	No	—	If null the task will be assigned ASAP as in the CATS UI
`description`	string	No	—	The description value
`is_completed`	boolean	No	—	Is Completed
`priority`	number	No	—	A number 1-5, with 1 being the lowest priority

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "number",
      "description": "The ID of the task to update."
    },
    "assigned_to_id": {
      "type": "number",
      "description": "The user to assign the task to"
    },
    "date_due": {
      "type": "string",
      "description": "If null the task will be assigned ASAP as in the CATS UI"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "is_completed": {
      "type": "boolean",
      "description": "Is Completed"
    },
    "priority": {
      "type": "number",
      "description": "A number 1-5, with 1 being the lowest priority"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

cats_admin_update_a_work_history

Update a work history Parameters:

Parameter	Type	Required	Default	Description
`work_history_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"
    },
    "work_history_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",
    "work_history_id"
  ]
}

cats_admin_update_an_activity

Update an activity Parameters:

Parameter	Type	Required	Default	Description
`id`	number	Yes	—	The ID of the activity to update.
`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	No	—	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 activity to update."
    },
    "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"
  ]
}

​Tools

​cats_admin_create_a_backup

​cats_admin_create_a_task

​cats_admin_create_a_webhook

​cats_admin_delete_a_task

​cats_admin_delete_a_webhook

​cats_admin_delete_a_work_history

​cats_admin_delete_an_activity

​cats_admin_delete_an_attachment

​cats_admin_download_an_attachment

​cats_admin_filter_activities

​cats_admin_get_a_backup

​cats_admin_get_a_portal

​cats_admin_get_a_tag

​cats_admin_get_a_task

​cats_admin_get_a_trigger

​cats_admin_get_a_user

​cats_admin_get_a_webhook

​cats_admin_get_a_work_history

​cats_admin_get_an_activity

​cats_admin_get_an_attachment

​cats_admin_get_portal_registration_application

​cats_admin_get_site

​cats_admin_list_all_activities

​cats_admin_list_all_backups

​cats_admin_list_all_events_starting_after_a_timestamp

​cats_admin_list_all_portals

​cats_admin_list_all_tags

​cats_admin_list_all_tasks

​cats_admin_list_all_triggers

​cats_admin_list_all_users

​cats_admin_list_all_webhooks

​cats_admin_list_portal_jobs

​cats_admin_parse_a_resume

​cats_admin_publish_portal_job

​cats_admin_search_activities

​cats_admin_submit

​cats_admin_submit_portal_registration_application

​cats_admin_unpublish_portal_job

​cats_admin_update_a_task

​cats_admin_update_a_work_history

​cats_admin_update_an_activity

Tools

cats_admin_create_a_backup

cats_admin_create_a_task

cats_admin_create_a_webhook

cats_admin_delete_a_task

cats_admin_delete_a_webhook

cats_admin_delete_a_work_history

cats_admin_delete_an_activity

cats_admin_delete_an_attachment

cats_admin_download_an_attachment

cats_admin_filter_activities

cats_admin_get_a_backup

cats_admin_get_a_portal

cats_admin_get_a_tag

cats_admin_get_a_task

cats_admin_get_a_trigger

cats_admin_get_a_user

cats_admin_get_a_webhook

cats_admin_get_a_work_history

cats_admin_get_an_activity

cats_admin_get_an_attachment

cats_admin_get_portal_registration_application

cats_admin_get_site

cats_admin_list_all_activities

cats_admin_list_all_backups

cats_admin_list_all_events_starting_after_a_timestamp

cats_admin_list_all_portals

cats_admin_list_all_tags

cats_admin_list_all_tasks

cats_admin_list_all_triggers

cats_admin_list_all_users

cats_admin_list_all_webhooks

cats_admin_list_portal_jobs

cats_admin_parse_a_resume

cats_admin_publish_portal_job

cats_admin_search_activities

cats_admin_submit

cats_admin_submit_portal_registration_application

cats_admin_unpublish_portal_job

cats_admin_update_a_task

cats_admin_update_a_work_history

cats_admin_update_an_activity