> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# workable-recruiting

> Workable Recruiting - manage jobs, candidates, offers, stages, and recruiters

**Server path:** `/workable-recruiting` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                              | Description                         |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| [`workable_recruiting_approve_offer`](#workable_recruiting_approve_offer)                                         | Approve an offer                    |
| [`workable_recruiting_copy_candidate`](#workable_recruiting_copy_candidate)                                       | Copy a candidate to another job     |
| [`workable_recruiting_create_candidate`](#workable_recruiting_create_candidate)                                   | Create a candidate                  |
| [`workable_recruiting_create_candidate_comment`](#workable_recruiting_create_candidate_comment)                   | Comment on a candidate              |
| [`workable_recruiting_create_talent_pool_candidate`](#workable_recruiting_create_talent_pool_candidate)           | Create talent pool candidate        |
| [`workable_recruiting_disqualify_candidate`](#workable_recruiting_disqualify_candidate)                           | Disqualify a candidate              |
| [`workable_recruiting_get_candidate`](#workable_recruiting_get_candidate)                                         | Get a candidate                     |
| [`workable_recruiting_get_job`](#workable_recruiting_get_job)                                                     | Get a job                           |
| [`workable_recruiting_get_job_application_form`](#workable_recruiting_get_job_application_form)                   | Get job application form            |
| [`workable_recruiting_get_offer`](#workable_recruiting_get_offer)                                                 | Get an offer                        |
| [`workable_recruiting_list_candidates`](#workable_recruiting_list_candidates)                                     | List candidates                     |
| [`workable_recruiting_list_job_activities`](#workable_recruiting_list_job_activities)                             | List job activities                 |
| [`workable_recruiting_list_job_questions`](#workable_recruiting_list_job_questions)                               | List job questions                  |
| [`workable_recruiting_list_jobs`](#workable_recruiting_list_jobs)                                                 | List jobs                           |
| [`workable_recruiting_list_recruiters`](#workable_recruiting_list_recruiters)                                     | List recruiters                     |
| [`workable_recruiting_list_stages`](#workable_recruiting_list_stages)                                             | List stages                         |
| [`workable_recruiting_move_candidate`](#workable_recruiting_move_candidate)                                       | Move a candidate to another stage   |
| [`workable_recruiting_reject_offer`](#workable_recruiting_reject_offer)                                           | Reject an offer                     |
| [`workable_recruiting_relocate_candidate`](#workable_recruiting_relocate_candidate)                               | Relocate a candidate to another job |
| [`workable_recruiting_revert_candidate_disqualification`](#workable_recruiting_revert_candidate_disqualification) | Revert candidate disqualification   |
| [`workable_recruiting_update_candidate`](#workable_recruiting_update_candidate)                                   | Update a candidate                  |

***

## workable\_recruiting\_approve\_offer

Approve an offer

**Parameters:**

| Parameter | Type   | Required | Default | Description   |
| --------- | ------ | -------- | ------- | ------------- |
| `id`      | string | Yes      | —       | The offer ID. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The offer ID."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_copy\_candidate

Copy a candidate to another job

**Parameters:**

| Parameter              | Type   | Required | Default | Description                                  |
| ---------------------- | ------ | -------- | ------- | -------------------------------------------- |
| `id`                   | string | Yes      | —       | The candidate's ID.                          |
| `member_id`            | string | Yes      | —       | The member performing the copy.              |
| `target_job_shortcode` | string | Yes      | —       | The shortcode of the destination job.        |
| `target_stage`         | string | No       | —       | The pipeline stage for the copied candidate. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The candidate's ID."
      },
      "member_id": {
        "type": "string",
        "description": "The member performing the copy."
      },
      "target_job_shortcode": {
        "type": "string",
        "description": "The shortcode of the destination job."
      },
      "target_stage": {
        "type": "string",
        "description": "The pipeline stage for the copied candidate."
      }
    },
    "required": [
      "PCID",
      "id",
      "member_id",
      "target_job_shortcode"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_create\_candidate

Create a candidate

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                                                    |
| ----------- | ------- | -------- | ------- | ------------------------------------------------------------------------------ |
| `shortcode` | string  | Yes      | —       | The job's shortcode.                                                           |
| `stage`     | string  | No       | —       | Determines which stage the candidate is placed in.                             |
| `candidate` | object  | Yes      | —       | The candidate data object.                                                     |
| `sourced`   | boolean | No       | —       | Indicates if candidate is sourced (true) or applied (false). Defaults to true. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "shortcode": {
        "type": "string",
        "description": "The job's shortcode."
      },
      "stage": {
        "type": "string",
        "description": "Determines which stage the candidate is placed in."
      },
      "candidate": {
        "type": "object",
        "description": "The candidate data object."
      },
      "sourced": {
        "type": "boolean",
        "description": "Indicates if candidate is sourced (true) or applied (false). Defaults to true."
      }
    },
    "required": [
      "PCID",
      "shortcode",
      "candidate"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_create\_candidate\_comment

Comment on a candidate

**Parameters:**

| Parameter   | Type   | Required | Default | Description                      |
| ----------- | ------ | -------- | ------- | -------------------------------- |
| `id`        | string | Yes      | —       | The candidate's ID.              |
| `comment`   | object | Yes      | —       | The comment content.             |
| `member_id` | string | Yes      | —       | The member creating the comment. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The candidate's ID."
      },
      "comment": {
        "type": "object",
        "description": "The comment content."
      },
      "member_id": {
        "type": "string",
        "description": "The member creating the comment."
      }
    },
    "required": [
      "PCID",
      "id",
      "comment",
      "member_id"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_create\_talent\_pool\_candidate

Create talent pool candidate

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                                                    |
| ----------- | ------- | -------- | ------- | ------------------------------------------------------------------------------ |
| `stage`     | string  | Yes      | —       | Candidate stage (e.g., 'sourced', 'applied').                                  |
| `candidate` | object  | Yes      | —       | The candidate data object.                                                     |
| `sourced`   | boolean | No       | —       | Indicates if candidate is sourced (true) or applied (false). Defaults to true. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "stage": {
        "type": "string",
        "description": "Candidate stage (e.g., 'sourced', 'applied')."
      },
      "candidate": {
        "type": "object",
        "description": "The candidate data object."
      },
      "sourced": {
        "type": "boolean",
        "description": "Indicates if candidate is sourced (true) or applied (false). Defaults to true."
      }
    },
    "required": [
      "PCID",
      "stage",
      "candidate"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_disqualify\_candidate

Disqualify a candidate

**Parameters:**

| Parameter              | Type    | Required | Default | Description                                                          |
| ---------------------- | ------- | -------- | ------- | -------------------------------------------------------------------- |
| `id`                   | string  | Yes      | —       | The candidate's ID.                                                  |
| `disqualify_note`      | string  | No       | —       | Additional info regarding disqualification (max 256 characters).     |
| `disqualify_reason_id` | string  | No       | —       | The ID of the disqualification reason.                               |
| `member_id`            | string  | Yes      | —       | The ID of the member performing the disqualification.                |
| `withdrew`             | boolean | No       | —       | Disqualification category: true for withdrawal, false for rejection. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The candidate's ID."
      },
      "disqualify_note": {
        "type": "string",
        "description": "Additional info regarding disqualification (max 256 characters)."
      },
      "disqualify_reason_id": {
        "type": "string",
        "description": "The ID of the disqualification reason."
      },
      "member_id": {
        "type": "string",
        "description": "The ID of the member performing the disqualification."
      },
      "withdrew": {
        "type": "boolean",
        "description": "Disqualification category: true for withdrawal, false for rejection."
      }
    },
    "required": [
      "PCID",
      "id",
      "member_id"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_get\_candidate

Get a candidate

**Parameters:**

| Parameter | Type   | Required | Default | Description         |
| --------- | ------ | -------- | ------- | ------------------- |
| `id`      | string | Yes      | —       | The candidate's ID. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The candidate's ID."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_get\_job

Get a job

**Parameters:**

| Parameter   | Type   | Required | Default | Description          |
| ----------- | ------ | -------- | ------- | -------------------- |
| `shortcode` | string | Yes      | —       | The job's shortcode. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "shortcode": {
        "type": "string",
        "description": "The job's shortcode."
      }
    },
    "required": [
      "PCID",
      "shortcode"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_get\_job\_application\_form

Get job application form

**Parameters:**

| Parameter   | Type   | Required | Default | Description          |
| ----------- | ------ | -------- | ------- | -------------------- |
| `shortcode` | string | Yes      | —       | The job's shortcode. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "shortcode": {
        "type": "string",
        "description": "The job's shortcode."
      }
    },
    "required": [
      "PCID",
      "shortcode"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_get\_offer

Get an offer

**Parameters:**

| Parameter | Type   | Required | Default | Description   |
| --------- | ------ | -------- | ------- | ------------- |
| `id`      | string | Yes      | —       | The offer ID. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The offer ID."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_list\_candidates

List candidates

**Parameters:**

| Parameter       | Type    | Required | Default | Description                                                           |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------- |
| `email`         | string  | No       | —       | Filter candidates by email address.                                   |
| `shortcode`     | string  | No       | —       | Filter by the job's shortcode.                                        |
| `stage`         | string  | No       | —       | Filter by job stage slug.                                             |
| `limit`         | integer | No       | —       | Number of candidates per page.                                        |
| `since_id`      | string  | No       | —       | Returns results with an ID greater than or equal to the specified ID. |
| `max_id`        | string  | No       | —       | Returns results with an ID less than or equal to the specified ID.    |
| `created_after` | string  | No       | —       | Returns results created after this timestamp (ISO 8601).              |
| `updated_after` | string  | No       | —       | Returns results updated after this timestamp (ISO 8601).              |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "email": {
        "type": "string",
        "description": "Filter candidates by email address."
      },
      "shortcode": {
        "type": "string",
        "description": "Filter by the job's shortcode."
      },
      "stage": {
        "type": "string",
        "description": "Filter by job stage slug."
      },
      "limit": {
        "type": "integer",
        "description": "Number of candidates per page."
      },
      "since_id": {
        "type": "string",
        "description": "Returns results with an ID greater than or equal to the specified ID."
      },
      "max_id": {
        "type": "string",
        "description": "Returns results with an ID less than or equal to the specified ID."
      },
      "created_after": {
        "type": "string",
        "description": "Returns results created after this timestamp (ISO 8601)."
      },
      "updated_after": {
        "type": "string",
        "description": "Returns results updated after this timestamp (ISO 8601)."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_list\_job\_activities

List job activities

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                                           |
| ----------- | ------- | -------- | ------- | --------------------------------------------------------------------- |
| `shortcode` | string  | Yes      | —       | The job's shortcode.                                                  |
| `limit`     | integer | No       | —       | Number of results per page (default 50).                              |
| `since_id`  | string  | No       | —       | Returns results with an ID greater than or equal to the specified ID. |
| `max_id`    | string  | No       | —       | Returns results with an ID less than or equal to the specified ID.    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "shortcode": {
        "type": "string",
        "description": "The job's shortcode."
      },
      "limit": {
        "type": "integer",
        "description": "Number of results per page (default 50)."
      },
      "since_id": {
        "type": "string",
        "description": "Returns results with an ID greater than or equal to the specified ID."
      },
      "max_id": {
        "type": "string",
        "description": "Returns results with an ID less than or equal to the specified ID."
      }
    },
    "required": [
      "PCID",
      "shortcode"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_list\_job\_questions

List job questions

**Parameters:**

| Parameter   | Type   | Required | Default | Description          |
| ----------- | ------ | -------- | ------- | -------------------- |
| `shortcode` | string | Yes      | —       | The job's shortcode. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "shortcode": {
        "type": "string",
        "description": "The job's shortcode."
      }
    },
    "required": [
      "PCID",
      "shortcode"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_list\_jobs

List jobs

**Parameters:**

| Parameter        | Type    | Required | Default | Description                                                                                                   |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `state`          | string  | No       | —       | Filter by job state: draft, published, archived, closed.                                                      |
| `limit`          | integer | No       | —       | Number of results per page (default 50).                                                                      |
| `since_id`       | string  | No       | —       | Returns results with an ID greater than or equal to the specified ID.                                         |
| `max_id`         | string  | No       | —       | Returns results with an ID less than or equal to the specified ID.                                            |
| `created_after`  | string  | No       | —       | Filter by creation timestamp (ISO 8601 format).                                                               |
| `updated_after`  | string  | No       | —       | Filter by update timestamp (ISO 8601 format).                                                                 |
| `include_fields` | string  | No       | —       | Comma-separated list of additional fields to include: description, full\_description, requirements, benefits. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "state": {
        "type": "string",
        "description": "Filter by job state: draft, published, archived, closed.",
        "enum": [
          "draft",
          "published",
          "archived",
          "closed"
        ]
      },
      "limit": {
        "type": "integer",
        "description": "Number of results per page (default 50)."
      },
      "since_id": {
        "type": "string",
        "description": "Returns results with an ID greater than or equal to the specified ID."
      },
      "max_id": {
        "type": "string",
        "description": "Returns results with an ID less than or equal to the specified ID."
      },
      "created_after": {
        "type": "string",
        "description": "Filter by creation timestamp (ISO 8601 format)."
      },
      "updated_after": {
        "type": "string",
        "description": "Filter by update timestamp (ISO 8601 format)."
      },
      "include_fields": {
        "type": "string",
        "description": "Comma-separated list of additional fields to include: description, full_description, requirements, benefits."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_list\_recruiters

List recruiters

**Parameters:**

| Parameter   | Type   | Required | Default | Description                                                                                             |
| ----------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `shortcode` | string | No       | —       | The job's shortcode. If provided, only recruiters collaborating on the correlated job will be returned. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "shortcode": {
        "type": "string",
        "description": "The job's shortcode. If provided, only recruiters collaborating on the correlated job will be returned."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_list\_stages

List stages

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_move\_candidate

Move a candidate to another stage

**Parameters:**

| Parameter                   | Type    | Required | Default | Description                                                          |
| --------------------------- | ------- | -------- | ------- | -------------------------------------------------------------------- |
| `id`                        | string  | Yes      | —       | The candidate's ID.                                                  |
| `fill_reserved_requisition` | boolean | No       | —       | When true, uses candidate's reserved requisition. Defaults to false. |
| `member_id`                 | string  | Yes      | —       | The member performing the move.                                      |
| `target_stage`              | string  | No       | —       | The stage the candidate should be moved to.                          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The candidate's ID."
      },
      "fill_reserved_requisition": {
        "type": "boolean",
        "description": "When true, uses candidate's reserved requisition. Defaults to false."
      },
      "member_id": {
        "type": "string",
        "description": "The member performing the move."
      },
      "target_stage": {
        "type": "string",
        "description": "The stage the candidate should be moved to."
      }
    },
    "required": [
      "PCID",
      "id",
      "member_id"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_reject\_offer

Reject an offer

**Parameters:**

| Parameter          | Type   | Required | Default | Description                   |
| ------------------ | ------ | -------- | ------- | ----------------------------- |
| `id`               | string | Yes      | —       | The offer ID.                 |
| `rejection_reason` | string | No       | —       | An optional rejection reason. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The offer ID."
      },
      "rejection_reason": {
        "type": "string",
        "description": "An optional rejection reason."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_relocate\_candidate

Relocate a candidate to another job

**Parameters:**

| Parameter              | Type   | Required | Default | Description                                |
| ---------------------- | ------ | -------- | ------- | ------------------------------------------ |
| `id`                   | string | Yes      | —       | The candidate's ID.                        |
| `member_id`            | string | Yes      | —       | The member performing the relocation.      |
| `target_job_shortcode` | string | Yes      | —       | Shortcode of the job to move candidate to. |
| `target_stage`         | string | No       | —       | Stage where candidate should be moved.     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The candidate's ID."
      },
      "member_id": {
        "type": "string",
        "description": "The member performing the relocation."
      },
      "target_job_shortcode": {
        "type": "string",
        "description": "Shortcode of the job to move candidate to."
      },
      "target_stage": {
        "type": "string",
        "description": "Stage where candidate should be moved."
      }
    },
    "required": [
      "PCID",
      "id",
      "member_id",
      "target_job_shortcode"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_revert\_candidate\_disqualification

Revert candidate disqualification

**Parameters:**

| Parameter   | Type   | Required | Default | Description                                                  |
| ----------- | ------ | -------- | ------- | ------------------------------------------------------------ |
| `id`        | string | Yes      | —       | The candidate's ID.                                          |
| `member_id` | string | Yes      | —       | The identifier of the member reverting the disqualification. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The candidate's ID."
      },
      "member_id": {
        "type": "string",
        "description": "The identifier of the member reverting the disqualification."
      }
    },
    "required": [
      "PCID",
      "id",
      "member_id"
    ]
  }
  ```
</Expandable>

***

## workable\_recruiting\_update\_candidate

Update a candidate

**Parameters:**

| Parameter | Type   | Required | Default | Description                 |
| --------- | ------ | -------- | ------- | --------------------------- |
| `id`      | string | Yes      | —       | The candidate's ID.         |
| `body`    | object | No       | —       | Candidate fields to update. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The candidate's ID."
      },
      "body": {
        "type": "object",
        "description": "Candidate fields to update."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>