---
title: "MCP Server: Available Actions and Information"
slug: "mcp-server-actions"
description: "A complete technical reference for Manatal MCP Server inputs, including field definitions and response data layouts."
updated: 2026-07-03T09:15:01Z
published: 2026-07-03T09:15:01Z
canonical: "support.manatal.com/mcp-server-actions"
---

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

# MCP Server: Available Actions and Information

This guide serves as a comprehensive reference for the input capabilities of the Manatal MCP Server. Below, you will find detailed specifications for available input fields and the structure of the response data you can expect to receive. For more details about Manatal MCP Server, please refer to this [article](https://support.manatal.com/docs/mcp-server).

## Search Candidates

- Find and filter candidates by experience, education, or location

| **Field Name** | **Type** | **Required** | **Description** | Example |
| --- | --- | --- | --- | --- |
| Candidate ID | Integer | No | Filter by candidate ID. | 10234 |
| Full Name | String | No | Filter by candidate full name. | Jane Doe |
| Creator ID | Integer | No | Filter by user ID who created the candidate. | 42123 |
| Owner ID | Integer | No | Filter by candidate owner ID. | 81245 |
| Source Type | String | No | Filter by candidate source type. | applied |
| Email | String | No | Filter by candidate email address. | jane.doe@example.com |
| Phone Number | String | No | Filter by candidate phone number. | +1-555-010-9988 |
| Gender | String | No | Filter by candidate gender. | Female |
| Birth Date (Start) | String | No | Filter by birth date greater than or equal to. | 1990-01-01 |
| Birth Date (End) | String | No | Filter by birth date less than or equal to. | 1995-12-31 |
| Address | String | No | Filter by candidate address. | 123 Main St, Springfield |
| Latest Degree | String | No | Filter by candidate's latest degree. | Bachelor of Science |
| Latest University | String | No | Filter by candidate's latest university. | Stanford University |
| Current Company | String | No | Filter by candidate's current company. | Tech Solutions Inc. |
| Current Position | String | No | Filter by candidate's current position. | Senior Developer |
| Description | String | No | Filter by candidate description. | Experienced in Python... |
| Candidate Tags | String | No | Filter by candidate tags. | python, remote, urgent |
| Candidate Industries | String | No | Filter by candidate industries. | Fintech, Healthcare |
| Location | String | No | Filter by candidate location. | New York |
| Created At (Start) | String | No | Filter by created date greater than or equal to. | 2025-01-01 |
| Created At (End) | String | No | Filter by created date less than or equal to. | 2025-06-30 |
| Updated At (Start) | String | No | Filter by updated date greater than or equal to. | 2025-11-01 |
| Updated (End) | String | No | Filter by updated date less than or equal to. | 2025-11-30 |

| **Field Name** | Example Values |
| --- | --- |
| Candidate ID | 10234 |
| Full Name | Jane Doe |
| Creator ID | 42241 |
| Owner ID | 81252 |
| Source Type | applied |
| Consent | true |
| Consent Date | 2025-01-01 |
| Email | jane.doe@example.com |
| Phone Number | +1-555-010-9988 |
| Gender | Female |
| Birth Date | 1990-01-01 |
| Address | 123 Main St, Springfield |
| Latest Degree | Bachelor of Science |
| Latest University | Stanford University |
| Current Company | Tech Solutions Inc. |
| Current Department | Tech |
| Current Position | Senior Developer |
| Location | New York |
| Candidate Tags | python, remote, urgent |
| Candidate Industries | Fintech, Healthcare |
| Description | Experienced in Python... |
| Custom Fields | {"salary_expectation": "120k", "willing_to_relocate": true} |
| Created At | 2025-06-30 |
| Updated At | 2025-11-01 |
  - Possible Inputs
  - Expected Output

## **View Candidate Profile**

- See complete details for a specific candidate

| Field Name | Type | Required | Description | Example Value |
| --- | --- | --- | --- | --- |
| Candidate ID | Integer | **Yes** | Candidate ID | 10234 |

| Field Name | Example Value |
| --- | --- |
| Candidate ID | 10234 |
| Full Name | Jane Doe |
| Creator ID | 45123 |
| Owner ID | 12531 |
| Source Type | applied |
| Consent | true |
| Consent Date | 2025-07-15 |
| Picture | https://example.com/picture/jdoe.jpg |
| Email | jane.doe@example.com |
| Resume | https://example.com/resumes/2025/jdoe_cv.pdf |
| Phone Number | +1-555-012-3456 |
| Gender | Female |
| Birth Date | 1992-05-20 |
| Address | 123 Maple Avenue, Suite 400, Springfield, IL |
| Zip Code | 62704 |
| Latest Degree | Master of Computer Science |
| Latest University | University of Illinois |
| Current Company | TechFlow Solutions |
| Current Department | Engineering |
| Current Position | Senior Backend Developer |
| Description | Experienced in Python... |
| Custom Fields | {"salary_expectation": "120k", "willing_to_relocate": true} |
| Created At | 2025-06-30 |
| Updated At | 2025-11-01 |
  - Possible Inputs
  - Expected Output

## **Add New Candidate**

- Add a new person to your candidate database

| **Field Name** | **Type** | **Required** | **Description** | **Example Value** |
| --- | --- | --- | --- | --- |
| Full Name | String | Yes | Full name of the candidate. | Jane Smith |
| Owner ID | Integer | No | ID of the owner of the candidate - default to creator if none is provided. | 55124 |
| Source Type | String | No | Origin of the candidate. Options: sourced, applied, referred, agency, other. | applied |
| Source Other | String | No | Field to add manual information to the source if the Source Type is other. | *null* |
| Consent | Boolean | No | Whether the candidate gave permission to use their data. | true |
| Email | String | No | Candidate email. | jane.smith@example.com |
| Phone Number | String | No | Candidate phone number. | +1-555-010-9988 |
| Gender | String | No | Gender of the candidate. Options: male, female, other, unknown. | Female |
| Birth Date | String | No | Candidate birth date. | 1990-05-20 |
| Address | String | No | Full address of the candidate. | 123 Maple Street, Springfield, IL |
| Zipcode | String | No | Code for the city of the address field. | 62704 |
| Latest Degree | String | No | Latest degree obtained by the candidate. | Master of Business Administration |
| Latest University | String | No | Latest university the candidate graduated from. | University of Illinois |
| Current Company | String | No | Company where the candidate currently works. | Global Corp |
| Current Department | String | No | Department where the candidate works. | Marketing |
| Current Position | String | No | Position of the candidate at his current job. | Marketing Manager |
| Description | String | No | Description of the candidate - can only input text here. | Experienced professional with 5+ years in digital strategy. |
| Custom Fields | Object | No | Candidate values for custom fields defined in Manatal. | {"salary_expectation": "80000"} |

| **Field Name** | Example |
| --- | --- |
| Candidate ID | 10234 |
| Full Name | Jane Doe |
| Creator ID | 42122 |
| Owner ID | 84212 |
| Source Type | applied |
| Consent | true |
| Consent Date | 2025-01-01 |
| Email | jane.doe@example.com |
| Phone Number | +1-555-010-9988 |
| Gender | Female |
| Birth Date | 1990-01-01 |
| Address | 123 Main St, Springfield |
| Latest Degree | Bachelor of Science |
| Latest University | Stanford University |
| Current Company | Tech Solutions Inc. |
| Current Department | Tech |
| Current Position | Senior Developer |
| Location | New York |
| Tags | python, remote, urgent |
| Industries | Fintech, Healthcare |
| Description | Experienced in Python... |
| Custom Fields | {"salary_expectation": "80000"} |
| Created At | 2025-06-30 |
| Updated At | 2025-11-01 |
  - Possible Inputs
  - Expected Output

## **View Candidate Education**

- See a candidate's educational background and qualifications
  - Possible Inputs

| Field Name | Type | Required | Description |
| --- | --- | --- | --- |
| Candidate ID | String | **Yes** | Candidate ID |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| ID | 48291 |
| Degree | Bachelor of Science in Computer Science |
| School | University of Washington |
| Location | Seattle, WA |
| Started At | 2018-09-01 |
| Ended At | 2022-06-15 |
| Description | Focused on software engineering and distributed systems. Member of the Robotics Club. |
| Created At | 2025-10-24 |

## **Add Candidate Education**

- Record degrees, certifications, and schooling for a candidate
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | **Example Value** |
| --- | --- | --- | --- | --- |
| Candidate ID | String | Yes | Candidate ID | 12342 |
| Degree | String | Yes | Name of the degree. | Bachelor |
| School | String | Yes | Name of the school. | Massachusetts Institute of Technology |
| Location | String | No | School location. | Cambridge, MA |
| Started At | String | No | Date the education was started. | 2016-09-01 |
| Ended At | String | No | Date the education was ended. | 2020-06-15 |
| Description | String | No | Description of the studies of the candidates. | Specialized in astrophysics and quantum mechanics. |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Education ID | 55011 |
| Degree | Bachelor |
| School | Yale University |
| Location | New Haven, CT |
| Started At | 2015-09-01 |
| Ended At | 2019-05-20 |
| Description | Graduated Magna Cum Laude. Senior thesis on medieval architecture. |
| Created At | 2025-12-01 |

## **View Candidate Work History**

- See a candidate's previous jobs and experience
  - Possible Inputs

| Field Name | Type | Required | Description | Example Value |
| --- | --- | --- | --- | --- |
| Candidate ID | String | **Yes** | Candidate ID | 12343 |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Experience ID | 1024 |
| Position | Senior Product Manager |
| Employer | Tech Solutions Inc. |
| Is Current Employer | True |
| Started At | 2020-01-15 |
| Ended At | *null* |
| Description | Leading the core platform team, responsible for roadmap strategy and cross-functional alignment. |
| Location | New York, NY |
| Created At | 2025-11-05 |

## **Add Candidate Work History**

- Record employment history and positions for a candidate
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | **Example Value** |
| --- | --- | --- | --- | --- |
| Candidate ID | String | Yes | Candidate ID | 12342 |
| Position | String | Yes | Name of the position. | Senior Marketing Specialist |
| Employer | String | Yes | Name of the company the candidate was working for. | Acme Corp |
| Is Current Employer | Boolean | No | Whether it is the current job of the candidate or not. | true |
| Started At | String | No | Date at which the candidate started the job. | 2019-06-01 |
| Ended At | String | No | Date at which the candidate left the job. | null |
| Description | String | No | Description of the job. | Managed social media campaigns and SEO strategy. |
| Location | String | No | Location of the office. | Austin, TX |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Experience ID | 70212 |
| Position | Software Engineer |
| Employer | Google |
| Is Current Employer | True |
| Started At | 2021-03-15 |
| Ended At | 2025-08-30 |
| Description | Developed backend microservices using Go and gRPC. |
| Location | Mountain View, CA |
| Created At | 2025-10-01 |

## **View Candidate Notes**

- Read all notes and comments about a candidate
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | Example Value |
| --- | --- | --- | --- | --- |
| Candidate ID | String | **Yes** | Candidate ID | 1234 |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Note ID | 8821 |
| Info | Candidate showed strong problem solving skills. |
| Creator | 42 |
| Created At | 2025-11-12 |

## **Add Candidate Notes**

- Write observations, interview feedback, or reminders about a candidate
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | **Example Value** |
| --- | --- | --- | --- | --- |
| Candidate ID | String | Yes | Candidate ID | 12341 |
| Info | String | Yes | The content or information body. | Candidate prefers remote work and has a valid visa. |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Note ID | 8821 |
| Info | Additional notes on the candidate's portfolio project. |
| Creator ID | 42 |
| Created At | 2025-11-12 |

## **Search Contacts**

- Find people at client companies
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | **Example Value** |
| --- | --- | --- | --- | --- |
| Contact ID | Integer | No | Filter by contact ID. | 90211 |
| Full Name | String | No | Filter by contact full name. | John Doe |
| Display Name | String | No | Filter by contact display name. | J. Doe |
| Email | String | No | Filter by contact email address. | john.doe@example.com |
| Phone Number | String | No | Filter by contact phone number. | +1-555-123-4567 |
| Organization ID | Integer | No | Filter by organization ID. | 55123 |
| Created At (Start) | String | No | Filter by created date greater than or equal to. | 2025-01-01 |
| Created At (End) | String | No | Filter by created date less than or equal to. | 2025-12-31 |
| Updated At (Start) | String | No | Filter by updated date greater than or equal to. | 2025-06-01 |
| Updated At (End) | String | No | Filter by updated date less than or equal to. | 2025-06-30 |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Contact ID | 3345 |
| Full Name | Alice Wonderland |
| Display Name | Alice |
| Email | alice@example.com |
| Picture | [https://example.com/images/alice.jpg](https://www.google.com/search?q=https://example.com/images/alice.jpg) |
| Phone Number | +1-555-019-2834 |
| Description | Key contact for the enterprise account. |
| Organization ID | 55123 |
| Custom Fields | {"priority": "high", "source": "referral"} |
| Creator ID | 88121 |
| Created At | 2025-10-25 |
| Updated At | 2025-10-26 |

## **View Contact Notes**

- Read notes about your client contacts
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | Example Value |
| --- | --- | --- | --- | --- |
| Contact ID | String | **Yes** | Contact ID | 1234 |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Note ID | 8911 |
| Info | Meeting notes from the job requisition call. |
| Creator ID | 25123 |
| Created At | 2025-12-10 |

## **Add Contact Notes**

- Record conversations or reminders about client contacts
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | Example Value |
| --- | --- | --- | --- | --- |
| Contact ID | String | **Yes** | Contact ID | 12341 |
| Info | String | **Yes** | The content or information body. | Follow up call scheduled for next Tuesday. |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Contact ID | 1234 |
| Note ID | 452 |
| Info | Follow up call scheduled for next Tuesday. |
| Creator ID | 12 |
| Created At | 2025-11-15 |

## **Search Jobs**

- Find open positions by role, status, or company
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | **Example Value** |
| --- | --- | --- | --- | --- |
| Job ID | Integer | No | Filter by job ID. | 50112 |
| Organization ID | Integer | No | Filter by organization ID. | 12412 |
| Position Name | String | No | Filter by job position name. | Senior Software Engineer |
| Headcount | Integer | No | Filter by number of positions to fill. | 31231 |
| Creator ID | Integer | No | Filter by user ID who created the job. | 88412 |
| Owner ID | Integer | No | Filter by job owner ID. | 88123 |
| Address | String | No | Filter by job address. | 123 Tech Lane, Suite 400 |
| Status | String | No | Filter by job status. | active |
| Frequency | String | No | Filter by salary frequency. | monthly |
| City | String | No | Filter by job city. | San Francisco |
| State | String | No | Filter by job state. | CA |
| Contract Details | String | No | Filter by contract type. | full_time |
| Is Published | Boolean | No | Filter by published status. | true |
| Is Remote | Boolean | No | Filter by remote work option. | false |
| Open At After | String | No | Filter by open date greater than or equal to. | 2025-01-01 |
| Open At Before | String | No | Filter by open date less than or equal to. | 2025-12-31 |
| Close At After | String | No | Filter by close date greater than or equal to. | 2025-06-01 |
| Close At Before | String | No | Filter by close date less than or equal to. | 2025-06-30 |
| Created At After | String | No | Filter by created date greater than or equal to. | 2025-09-01 |
| Created At Before | String | No | Filter by created date less than or equal to. | 2025-09-30 |
| Updated At After | String | No | Filter by updated date greater than or equal to. | 2025-10-01 |
| Updated At Before | String | No | Filter by updated date less than or equal to. | 2025-10-15 |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Job ID | 20481 |
| Organization ID | 12231 |
| Position Name | Senior Data Analyst |
| Description | Analyze large datasets to drive business strategies. |
| Headcount | 22411 |
| Creator ID | 55632 |
| Salary Min | 60000 |
| Salary Max | 95000 |
| Currency ID | 1 |
| Owner ID | 55241 |
| Address | 456 Innovation Drive |
| Zipcode | 94043 |
| Contract Details | full_time |
| Is Published | true |
| Is Remote | true |
| Status | active |
| Frequency | monthly |
| City | Mountain View |
| State | CA |
| Open At | 2025-11-01 |
| Close At | 2024-02-01 |
| Created At | 2025-10-15 |
| Updated At | 2025-10-20 |
| Career Page URL | https://example.careers-page.com/jobs/2048 |
| Custom Fields | {"department": "Analytics", "priority": "high"} |
| Is Pinned In Career Page | false |
| Industry | {"id": 7, "name": "Tech"} |

## **Create Job Opening**

- Add a new position you're looking to fill
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | Example Value |
| --- | --- | --- | --- | --- |
| Organization ID | Integer | **Yes** | Organization the job is assigned to. | 12123 |
| Position Name | String | **Yes** | Job title. | Product Designer |
| Description | String | No | Description of the job. | Responsible for UI/UX design of mobile apps. |
| Headcount | Integer | No | Number of people to be hired for the job. | 1 |
| Salary Min | String | No | Minimum Salary | 50000.00 |
| Salary Max | String | No | Maximum Salary | 75000.00 |
| Currency ID | Integer | No | ID of the Currency | 2 |
| Owner ID | Integer | No | ID of the owner of the job. | 45568 |
| Address | String | No | Address of the office the job will take place. | 10 Downing Street, London |
| Zipcode | String | No | Code of the city for the address of the office. | 1234 |
| Contract Details | String | No | Options: `full_time`, `part_time`, `temporary`, `freelance`, `internship`, `apprenticeship`, `contractor`, `consultancy`. | full_time |
| Is Published | Boolean | No | Is the Job Published to the Careers page. Options `true`, `false` | true |
| Is Remote | Boolean | No | Is the job Remote Options: `true`, `false` | false |
| Status | String | No | Status of the job. Options: `active`, `on_hold`, `won`, `lost`. | "active" |
| Custom Fields | Object | No | Job values for custom fields defined in Manatal. | {"Relocation": "Provided"} |
| Is Pinned In Career Page | Boolean | No | Whether the job has been added to the career page or not. | true |
| Industry | Object | No | Job industry | Tech |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Job ID | 8055 |
| Organization ID | 10234 |
| Position Name | DevOps Engineer |
| Description | Responsible for maintaining CI/CD pipelines and cloud infrastructure. |
| Headcount | 2 |
| Creator ID | 33235 |
| Salary Min | 90000 |
| Salary Max | 130000 |
| Currency ID | 2 |
| Owner ID | 33115 |
| Address | 500 Tech Park Way |
| Zipcode | 98109 |
| Contract Details | full_time |
| Is Published | true |
| Is Remote | true |
| Status | active |
| Created At | 2025-10-05 |
| Updated At | 2025-10-10 |
| Career Page URL | [https://careers.example.com/jobs/805](https://www.google.com/search?q=https://careers.example.com/jobs/805) |
| Custom Fields | {"tech_stack": "AWS, Docker, Kubernetes"} |
| Is Pinned In Career Page | false |
| Industry | {"id": 3, "name": "Tech"} |

## **View Job Details**

- See all information about a specific position
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | Example Value |
| --- | --- | --- | --- | --- |
| Job ID | String | **Yes** | Job ID | 1234 |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Job ID | 80512 |
| Organization ID | 10241 |
| Position Name | DevOps Engineer |
| Description | Responsible for maintaining CI/CD pipelines and cloud infrastructure. |
| Headcount | 2 |
| Creator ID | 33124 |
| Salary Min | 90000 |
| Salary Max | 130000 |
| Currency ID | 2 |
| Owner ID | 33124 |
| Address | 500 Tech Park Way |
| Zipcode | 98109 |
| Contract Details | full_time |
| Is Published | true |
| Is Remote | true |
| Status | active |
| Created At | 2025-10-05 |
| Updated At | 2025-10-10 |
| Career Page URL | [https://careers.example.com/jobs/805](https://www.google.com/search?q=https://careers.example.com/jobs/805) |
| Custom Fields | `{"tech_stack": "AWS, Docker, Kubernetes"}` |
| Is Pinned In Career Page | false |
| Industry | `{"id": 3, "name": "Information Technology"}` |

## **View Job Notes**

- Read notes and updates about a job opening
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | Example |
| --- | --- | --- | --- | --- |
| Job ID | String | **Yes** | Job ID | 3386073 |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Note ID | 1234567 |
| Info | Internal note regarding salary negotiation. |
| Creator ID | 4521572 |
| Created At | 2025-11-15 |

## **Add Job Notes**

- Record updates, requirements, or hiring progress
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | Example Value |
| --- | --- | --- | --- | --- |
| Job ID | String | **Yes** | Job ID | 3386073 |
| Info | String | **Yes** | The content or information body of the note. | Reminder to add Benefits to Job Description |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Note ID | 1234567 |
| Info | Reminder to add Benefits to Job Description |
| Creator ID | 4521572 |
| Created At | 2025-11-15 |

## **View Candidate Matches**

- See which candidates have been matched to which jobs and their progress
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | Example Value |
| --- | --- | --- | --- | --- |
| Stage IDs | String | No | Filter by stage IDs (comma-separated). | 10, 24, 33 |
| Job ID | String | No | Filter by Job ID | 12345 |
| Hired At (Start) | String | No | Filter by hired date greater than or equal to. | 2025-01-01 |
| Hire At (End) | String | No | Filter by hired date less than or equal to. | 2025-12-31 |
| Submitted At (Start) | String | No | Filter by submitted date greater than or equal to. | 2025-06-01 |
| Submitted At (End) | String | No | Filter by submitted date less than or equal to. | 2025-06-30 |
| Interview At (Start) | String | No | Filter by interview date greater than or equal to. | 2025-07-01 |
| Interview At (End) | String | No | Filter by interview date less than or equal to. | 2025-07-15 |
| Offer At (Start) | String | No | Filter by offer date greater than or equal to. | 2025-08-01 |
| Offer At (End) | String | No | Filter by offer date less than or equal to. | 2025-08-10 |
| Dropped At (Start) | String | No | Filter by dropped date greater than or equal to. | 2025-09-01 |
| Dropped At (End) | String | No | Filter by dropped date less than or equal to. | 2025-09-30 |
| Created At (Start) | String | No | Filter by created date greater than or equal to. | 2025-10-01 |
| Created At (End) | String | No | Filter by created date less than or equal to. | 2025-10-31 |
| Updated At (Start) | String | No | Filter by updated date greater than or equal to. | 2025-11-01 |
| Updated At (End) | String | No | Filter by updated date less than or equal to. | 2025-11-15 |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Match ID | 99011 |
| Owner ID | 42124 |
| Organization ID | 10124 |
| Job ID | 30551 |
| Candidate ID | 10241 |
| Creator ID | 42125 |
| Stage | {"id": 4, "name": "Technical Interview"} |
| Is Active | true |
| Hired At | *null* |
| Submitted At | 2025-11-01 |
| Interview At | 2025-11-10 |
| Offer At | *null* |
| Dropped At | *null* |
| Created At | 2025-10-31 |
| Updated At | 2025-11-10 |

## **Match Candidate to Job**

- Connect a candidate with a job opening
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | Example Value |
| --- | --- | --- | --- | --- |
| Owner ID | Integer | No | Owner of the match. | 42 |
| Job ID | Integer | **Yes** | Job the candidate is matched with. | 305 |
| Candidate ID | Integer | **Yes** | Candidate that has a match with a job. | 1024 |
| Stage | Object | No | Stage of the match (requires internal Stage ID). | {"id": 3, "name": "Interview"} |
| Is Active | Boolean | No | Whether the match is still active or not. | true |
| Hired At | String | No | Date at which the candidate was hired. | 2025-12-01 |
| Submitted At | String | No | Date at which the candidate was added to the job. | 2025-11-01 |
| Interview At | String | No | Date at which the candidate was last interviewed. | 2025-11-15 |
| Offer At | String | No | Date at which an offer was made to the candidate. | 2025-11-25 |
| Dropped At | String | No | Date at which the candidate was no longer considered for the job. | 2024-01-01 |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Match ID | 5001 |
| Owner ID | 10 |
| Organization ID | 5 |
| Job ID | 200 |
| Candidate ID | 750 |
| Creator ID | 10 |
| Stage | `{"id": 2, "name": "Phone Screening"}` |
| Is Active | true |
| Hired At | *null* |
| Submitted At | 2025-11-20 |
| Interview At | 2025-11-25 |
| Offer At | *null* |
| Dropped At | *null* |
| Created At | 2025-11-20 |
| Updated At | 2025-11-26 |

## **Search Organizations**

- Find client companies in your database
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | Example Value |
| --- | --- | --- | --- | --- |
| Organization ID | Integer | No | Filter by organization ID. | 45914 |
| Name | String | No | Filter by organization name. | Acme Corp |
| Creator ID | Integer | No | Filter by user ID who created the organization. | 102753 |
| Owner ID | Integer | No | Filter by organization owner ID. | 88734 |
| Address | String | No | Filter by organization address. | 123 Innovation Dr, Austin, TX |
| Website | String | No | Filter by organization website. | [https://examplecom](https://acme.com/) |
| Is Public | Boolean | No | Filter by public visibility status. | true |
| Is Visible | Boolean | No | Filter by visibility status. | true |
| Created At (Start) | String | No | Filter by created date greater than or equal to. | 2025-01-01 |
| Created At (End) | String | No | Filter by created date less than or equal to. | 2025-12-31 |
| Updated At (Start) | String | No | Filter by updated date greater than or equal to. | 2025-06-15 |
| Updated At (End) | String | No | Filter by updated date less than or equal to. | 2025-06-15 |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Organization ID | 45911 |
| Name | Acme Corp |
| Description | Global provider of widgets and tech solutions. |
| Logo | https://example/logo.png |
| Creator ID | 102424 |
| Owner ID | 881242 |
| Address ID | 123 Innovation Dr, Austin, TX |
| Website | https://example.com |
| Is Public | true |
| Is Visible | true |
| Custom Fields | {"industry": "Tech", "tier": "Gold"} |
| Created At | 2025-01-01 |
| Updated At | 2025-06-15 |

## **Add Organization**

- Create a new organization.
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | **Example Value** |
| --- | --- | --- | --- | --- |
| Name | String | Yes | Name of the organization. | Globex Corporation |
| Description | String | No | Description of the organization. | Leading provider of logistics solutions. |
| Logo | String (URI) | No | Link to the organization logo. | https://cdn.site.com/globex_logo.png |
| Creator ID | Integer | No | User who created the organization. | 25 |
| Owner ID | Integer | No | Owner of the organization. | 88 |
| Address | String | No | Address of the organization. | 123 Market St, San Francisco, CA |
| Website | String | No | Website of the organization. | https://www.globex.com |
| Is Public | Boolean | No | Whether the organization and its details are visible to all users. | true |
| Is Visible | Boolean | No | Whether an organization minimal details are visible to all users. | true |
| Custom Fields | Object | No | Organization values for custom fields defined in Manatal. | {"industry": "Tech", "tier": "Enterprise"} |
| Created At | String | No | Date at which the organization was created. | 2025-10-01 |
| Updated At | String | No | No description provided. | 2025-10-05 |
  - Expected Output

| **Field Name** | **Type** | **Description** | **Example Value** |
| --- | --- | --- | --- |
| Organization ID | Integer | Unique identifier for the organization. | 1050 |
| External ID | String | ID of the organization in the external system. | EXT-4421 |
| Name | String | The display name of the organization. | Globex Corporation |
| Description | String | Brief summary or bio of the organization. | Leading provider of logistics solutions. |
| Logo | String | URL link to the organization's logo image. | https://cdn.site.com/globex_logo.png |
| Creator ID | Integer | User ID of the person who created the record. | 25 |
| Owner ID | Integer | User ID of the current owner of the organization. | 88 |
| Address | String | Physical location or billing address. | 123 Market St, San Francisco, CA |
| Website | String | Official website URL. | https://www.globex.com |
| Is Public | Boolean | Indicates if the organization is visible to all users. | true |
| Is Visible | Boolean | Indicates if minimal details are visible. | true |
| Custom Fields | Object | Key-value pairs for custom defined data. | {"industry": "Tech", "tier": "Enterprise"} |
| Created At | String | ISO 8601 timestamp of creation. | 2025-10-01 |
| Updated At | String | ISO 8601 timestamp of the last update. | 2025-10-05 |

## **View Organization Notes**

- Read notes about a client company
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | Example Value |
| --- | --- | --- | --- | --- |
| Organization ID | String | **Yes** | Organization ID | 4591 |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Note ID | 50123 |
| Info | Client requested a follow-up meeting next Tuesday. |
| Creator ID | 42124 |
| Created At | 2025-11-15 |

## **Add Organization Notes**

- Record information about client relationships and interactions
  - Possible Inputs

| **Field Name** | **Type** | **Required** | **Description** | **Example Value** |
| --- | --- | --- | --- | --- |
| Organization ID | String | **Yes** | Organization ID | 4591 |
| Info | String | **Yes** | The content or information body | Client requested a follow-up meeting next Tuesday. |
  - Expected Output

| **Field Name** | **Example Value** |
| --- | --- |
| Note ID | 50124 |
| Info | Client requested a follow-up meeting next Tuesday. |
| Creator ID | 42124 |
| Created At | 2025-11-15 |