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.
For the best experience, use ChatGPT or Claude. it supports every action listed below.
1. Search Candidates
Find and filter candidates by experience, education, or location
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Full Name | String | No | Filter by candidate full name | Jane Doe |
| 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 gender (comma-separated: unknown, male, female, other) | female |
| Birth Date (Start) | Date | No | Filter by birth date greater than or equal to | 1990-01-01 |
| Birth Date (End) | Date | No | Filter by birth date less than or equal to | 1995-12-31 |
| Current Company | String | No | Filter by current company | Tech Solutions Inc. |
| Current Position | String | No | Filter by current position | Senior Developer |
| Latest University | String | No | Filter by latest university | Stanford University |
| Location | String | No | Filter by location | New York |
| Source Type | String | No | Filter by source type | applied |
| Creator ID(s) | String | No | Filter by user ID who created the candidates | 42123 |
| Owner ID(s) | String | No | Filter by candidate owner ID | 81245 |
| Industry ID(s) (OR) | String | No | Filter by candidate industry ID obtained by the list_industries tool | 3,7 |
| Industry ID(s) (AND) | String | No | Filter by candidate industry ID obtained by the list_industries tool | 3,7 |
| Tags | String | No | Filter by comma-separated tag IDs obtained by list_candidate_tags | 5,9 |
| Created At (Start) | Date | No | Filter by created date greater than or equal to | 2025-01-01 |
| Created At (End) | Date | No | Filter by created date less than or equal to | 2025-06-30 |
| Updated At (Start) | Date | No | Filter by updated date greater than or equal to | 2025-11-01 |
| Updated At (End) | Date | No | Filter by updated date less than or equal to | 2025-11-30 |
| Page | Integer | No | Page number | 1 |
| Page Size | Integer | No | Results per page | 20 |
Expected Output
| Field Name | Example Values |
|---|---|
| Candidate ID | 10234 |
| Full Name | Jane Doe |
| Creator ID | 42241 |
| Owner ID | 81252 |
| Source Type | applied |
| jane.doe@example.com | |
| Phone Number | +1-555-010-9988 |
| Gender | female |
| Birth Date | 1990-01-01 |
| Consent | true |
| Consent Date | 2025-06-30 |
| Address | 123 Main St, Springfield |
| Zip Code | 12345 |
| Latest Degree | Bachelor of Science |
| Latest University | Stanford University |
| Current Company | Tech Solutions Inc. |
| Current Department | Engineering |
| Current Position | Senior Developer |
| Description | Experienced software developer with a strong background in full-stack web development and team leadership. |
| Location | New York |
| Created At | 2025-06-30 |
| Updated At | 2025-11-01 |
| Candidate Tags | Java, Backend Development, Team Lead |
| Custom Fields | {"linkedin": "linkedin.com/in/janedoe", "notice_period": "30 days"} |
| Industries | Information Technology |
2. Create Candidate
Add a new person to your candidate database
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Full Name | String | Yes | Full name of the candidate | Jane Doe |
| String | No | Email address | jane.doe@example.com | |
| Phone Number | String | No | Phone number | +1-555-010-9988 |
| Gender | String | No | male, female, other, unknown | female |
| Birth Date | Date | No | Date of birth | 1990-01-01 |
| Address | String | No | Street address | 123 Main St, Springfield |
| Zip Code | String | No | Postal/zip code | 62704 |
| Current Company | String | No | Current employer name | Tech Solutions Inc. |
| Current Department | String | No | Current department | Engineering |
| Current Position | String | No | Current job title | Senior Developer |
| Latest Degree | String | No | Most recent degree name | Bachelor of Science |
| Latest University | String | No | Most recent university name | Stanford University |
| Description | String | No | Free-text notes/summary | Experienced in Python… |
| 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 | Found via industry meetup |
| Consent | Boolean | No | Whether the candidate gave permission to use their data | true |
| Custom Fields | Array | No | Candidate values for custom fields defined in Manatal | [{"field_id":4,"value":"120k"}] |
Expected Output
| Field Name | Example Values |
|---|---|
| Candidate ID | 10234 |
| Full Name | Jane Doe |
| Creator ID | 42241 |
| Owner ID | 81252 |
| Source Type | applied |
| jane.doe@example.com | |
| Phone Number | +1-555-010-9988 |
| Gender | female |
| Birth Date | 1990-01-01 |
| Consent | true |
| Consent Date | 2025-06-30 |
| Address | 123 Main St, Springfield |
| Latest Degree | Bachelor of Science |
| Latest University | Stanford University |
| Current Company | Tech Solutions Inc. |
| Current Department | Engineering |
| Current Position | Senior Developer |
| Description | Experienced software developer with a strong background in full-stack web development and team leadership. |
| Location | New York |
| Created At | 2025-06-30 |
| Updated At | 2025-11-01 |
| Candidate Tags | ["Java", "Backend Development", "Team Lead"] |
| Custom Fields | {"linkedin": "linkedin.com/in/janedoe", "notice_period": "30 days"} |
| Industries | Information Technology |
3. Get Candidate
See complete details for a specific candidate
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | ID of the candidate to retrieve | 10234 |
Expected Output
| Field Name | Example Values |
|---|---|
| Candidate ID | 10234 |
| Full Name | Jane Doe |
| Creator ID | 42241 |
| Owner ID | 81252 |
| Source Type | applied |
| jane.doe@example.com | |
| Phone Number | +1-555-010-9988 |
| Gender | female |
| Birth Date | 1990-01-01 |
| Consent | true |
| Consent Date | 2025-06-30 |
| Address | 123 Main St, Springfield |
| Zip Code | 12345 |
| Latest Degree | Bachelor of Science |
| Latest University | Stanford University |
| Current Company | Tech Solutions Inc. |
| Current Department | Engineering |
| Current Position | Senior Developer |
| Description | Experienced software developer with a strong background in full-stack web development and team leadership. |
| Location | New York |
| Created At | 2025-06-30 |
| Updated At | 2025-11-01 |
| Candidate Tags | Java, Backend Development, Team Lead |
| Custom Fields | {"linkedin": "linkedin.com/in/janedoe", "notice_period": "30 days"} |
| Industries | Information Technology |
4. Update Candidate
Update selected details on an existing candidate profile.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | Candidate ID | 10234 |
| Full Name | String | No | Full name of the candidate | Jane Doe |
| Source Type | String | No | How the candidate was sourced. Options: sourced, applied, referred, agency, other. | applied |
| Source Other | String | No | Additional source information when Source Type is "other". | Industry meetup |
| Consent | Boolean | No | Whether the candidate has given data consent | true |
| String | No | Email address | jane.doe@example.com | |
| Phone Number | String | No | Phone number | +1-555-010-9988 |
| Gender | String | No | Gender Options: male, female, other, unknown. | female |
| Birth Date | Date | No | Date of birth (YYYY-MM-DD) | 1990-01-01 |
| Address | String | No | Street address | 123 Main St, Springfield |
| Zip Code | String | No | Postal/zip code | 62704 |
| Latest Degree | String | No | Most recent degree name | Bachelor of Science |
| Latest University | String | No | Most recent university name | Stanford University |
| Current Company | String | No | Current employer name | Tech Solutions Inc. |
| Current Department | String | No | Current department | Engineering |
| Current Position | String | No | Current job title | Senior Developer |
| Description | String | No | Free-text notes or summary about the candidate | Experienced software developer |
| Custom Field Input | Array | No | Candidate values for custom fields defined in Manatal | [{"field":"seniority","value":"Senior"}] |
Expected Output
| Field Name | Example Values |
|---|---|
| Candidate ID | 10234 |
| Full Name | Jane Doe |
| Creator ID | 42241 |
| Owner ID | 81252 |
| Source Type | applied |
| jane.doe@example.com | |
| Phone Number | +1-555-010-9988 |
| Gender | female |
| Birth Date | 1990-01-01 |
| Consent | true |
| Consent Date | 2025-06-30 |
| Address | 123 Main St, Springfield |
| Latest Degree | Bachelor of Science |
| Latest University | Stanford University |
| Current Company | Tech Solutions Inc. |
| Current Department | Engineering |
| Current Position | Senior Developer |
| Description | Experienced software developer with a strong background in full-stack web development and team leadership. |
| Location | New York |
| Created At | 2025-06-30 |
| Updated At | 2025-11-01 |
| Candidate Tags | ["Java", "Backend Development", "Team Lead"] |
| Custom Fields | {"linkedin": "linkedin.com/in/janedoe", "notice_period": "30 days"} |
| Industries | Information Technology |
5. Get Candidate Resume
Retrieve a candidate’s resumes and parsed CV content.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | Candidate ID | 10234 |
Expected Output
Returns a list of resumes; Resume Parsed Edited contains the parsed CV content, while Is Default identifies the primary resume and State indicates processing status.
| Field Name | Example Values |
|---|---|
| Resume ID | 1 |
| State | completed |
| Resume File Name | Jane_Doe_CV.pdf |
| Resume Parsed Edited | {} |
| Is Default | true |
6. List Candidate Social Media
List a candidate’s confirmed social media profiles.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | Candidate ID | 10234 |
Expected Output
| Field Name | Example Values |
|---|---|
| Social Profile ID | 1 |
| Social Media Slug | |
| Social Media Name | |
| Social Media URL | https://www.linkedin.com/in/janedoe |
| Picture | null |
7. Get Candidate Fields
Retrieve the client’s native and custom candidate field definitions.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| (none — no parameters) | — | — | — | — |
Expected Output
Fields are nested within profile columns and groups; groups[].fields[] identifies an individual field definition, not a candidate’s saved value.
| Field Name | Example Values |
|---|---|
| groups[] → Name | Personal Details |
| groups[] → Is Hidden | false |
| groups[].fields[] → Slug | seniority |
| groups[].fields[] → Name | Seniority |
| groups[].fields[] → Description | Candidate’s seniority level |
| groups[].fields[] → Field Type | dropdown |
| groups[].fields[] → Answer Choices | ["Junior","Senior"] |
| groups[].fields[] → Answer Choice Type | text |
| groups[].fields[] → Is Required | false |
| groups[].fields[] → Is Native | false |
| groups[].fields[] → Is Hidden | false |
8. List Candidate Tags
List available candidate tags
Possible Inputs
No input
Expected Output
| Field Name | Example Values |
|---|---|
| Tag ID | 5 |
| Name | urgent |
9. List Candidate Educations
See a candidate's educational background and qualifications
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | Candidate ID | 10234 |
Expected Output
| Field Name | Example Values |
|---|---|
| ID | 3312 |
| School | Stanford University |
| Degree | Bachelor of Science |
| Started At | 2010-09-01 |
| Ended At | 2014-06-01 |
| Location | Seattle, WA |
| Description | Focused on software engineering and distributed systems. Member of the Robotics Club. |
10. Add Candidate Education
Record degrees, certifications, and schooling for a candidate
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | ID of the candidate | 10234 |
| School ID | Integer | Yes | ID from search_schools | 1123 |
| Degree ID | Integer | No | ID from search_degrees | 45 |
| Description | String | No | Additional details | Graduated with honors |
| Started At | Date | No | Date the education was started | 2010-09-01 |
| Ended At | Date | No | Date the education was ended | 2014-06-01 |
Expected Output
| Field Name | Example Values |
|---|---|
| Education ID | 3312 |
| Candidate ID | 10234 |
| School | Stanford University |
| Degree | Bachelor of Science |
| Location display | Bangkok Thailand |
| Description | Focused on software engineering and distributed systems. Member of the Robotics Club. |
| Started At | 2010-09-01 |
| Ended At | 2014-06-01 |
11. List Candidate Experiences
See a candidate's previous jobs and experience
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | Candidate ID | 10234 |
Expected Output
| Field Name | Example Values |
|---|---|
| Experience ID | 9981 |
| Employer | Tech Solutions Inc. |
| Employer ID | 123 |
| Position | Senior Developer |
| Position ID | 123 |
| Started At | 2018-01-01 |
| Ended At | 2020-01-02 |
| Is Current Employer | true |
| Description | Leading the core platform team, responsible for roadmap strategy and cross-functional alignment. |
| Location | New York, NY |
12. Add Candidate Experience
Record employment history and positions for a candidate
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | Candidate ID | 10234 |
| Employer ID | Integer | Yes | ID from search_employers | 771 |
| Position ID | Integer | Yes | ID from search_positions | 220 |
| Description | String | No | Responsibilities/achievements | Led backend team of 5 |
| Started At | Date | No | Date when the candidate started the job | 2018-01-01 |
| Ended At | Date | No | Date at which the candidate left the job | 2022-05-01 |
| Is Current Employer | Boolean | No | Whether this is the candidate's current employer | true |
Expected Output
| Field Name | Example Values |
|---|---|
| Experience ID | 9981 |
| Candidate ID | 10234 |
| Employer | Tech Solutions Inc. |
| Position | Senior Developer |
| Position ID | 220 |
| Started At | 2018-01-01 |
| Ended At | 2020-01-01 |
| Is Current Employer | true |
| Description | Managed social media campaigns and SEO strategy. |
| Location Display | Austin, TX |
13. List Candidate Notes
Read all notes and comments about a candidate
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | ID of the candidate | 10234 |
Expected Output
| Field Name | Example Values |
|---|---|
| Note ID | 5521 |
| Info | Great communication skills |
| Creator ID | 42241 |
| Creator Name | Emma |
| Created At | 2025-11-01 |
14. Add Candidate Note
Write observations, interview feedback, or reminders about a candidate
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | Candidate ID | 10234 |
| Info | String | Yes | The content or information body. | Candidate prefers remote work and has a valid visa |
Expected Output
| Field Name | Example Values |
|---|---|
| Note ID | 5521 |
| Creator name | Emma |
| Info | Candidate prefers remote work and has a valid visa |
| Creator ID | 42241 |
| Created At | 2026-07-02 |
15. List Candidate Meetings
List a candidate’s AI Interviewer and AI Notetaker meetings and assessments.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | Candidate ID | 10234 |
| Meeting Source | String | No | Filter by meeting source. ai_interviewer returns only AI interviewer meetings; ai_notetaker returns every other source. Omit to return all. Options: ai_interviewer, ai_notetaker. |
ai_interviewer |
| Page | Integer | No | Page number | 1 |
| Page Size | Integer | No | Results per page (max 10) | 10 |
Expected Output
Assessment contains JSON content when available; retrieve transcripts through Get Meeting.
| Field Name | Example Values |
|---|---|
| Meeting ID | 901 |
| Client ID | 123 |
| Activity ID | 7789 |
| Title | Candidate interview |
| Meeting Time | 2026-09-22T09:00:00Z |
| Meeting URL | null |
| Is Guest Shared | false |
| Is Archived | false |
| Created At | 2026-09-22T09:00:00Z |
| Updated At | 2026-09-22T09:00:00Z |
| Job ID | 5567 |
| Candidate ID | 10234 |
| Status | completed |
| Source Type | ai_interviewer |
| Duration | 1800 |
| Assessment | null |
16. List Candidate Activities
List activities linked to a candidate.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | ID of the candidate. | 123 |
| Title Contains | String | No | Case-insensitive activity title filter. | interview |
| Activity Types | String | No | Comma-separated types: call, meeting, task, email, interview. | meeting,interview |
| Due Date (Start) | Date-time | No | At or after this UTC time. A bare date means midnight UTC. | 2026-11-05T00:00:00Z |
| Due Date (End) | Date-time | No | At or before this UTC time. Use 23:59:59Z to include the whole day; a bare date means midnight UTC. | 2026-11-05T23:59:59Z |
| Completed | Boolean | No | true for completed activities; false for open activities. | false |
| Creator IDs | String | No | Comma-separated creator user IDs. | 1,2 |
| Ordering | String | No | name, activity_type, due_date, created_at, or updated_at; prefix with - for descending. | due_date |
| Page | Integer | No | Page number. | 1 |
| Page Size | Integer | No | Results per page. | 20 |
Expected Output
| Field Name | Example Values |
|---|---|
| Activity ID | 456 |
| Name | Candidate interview |
| Description | Technical interview |
| Activity Type | interview |
| Linked Record Type | candidate |
| Linked Record ID | 123 |
| Linked Record Name | Jane Doe |
| Candidate ID (when linked to a match) | 123 |
| Start Time | 2026-11-05T03:00:00Z |
| Duration | 01:00:00 |
| Completed | false |
| Importance | normal |
| All Day | false |
| Location | Online |
| Online Meeting URL | https://example.com/meeting |
| Online Meeting Type | manual |
| Online Meeting Status | success |
| Creator ID | 1 |
| Creator Name | Alex Smith |
| Assignees → ID | 1 |
| Assignees → Name | Alex Smith |
| Assignees → Role | admin |
| Attendees → Candidate ID | 123 |
| Attendees → Candidate Name | Jane Doe |
| Attendees → Email | jane@example.com |
| Attendees → BCC | false |
| Created At | 2026-11-04T03:00:00Z |
| Updated At | 2026-11-04T03:00:00Z |
17. Search Organizations
Find client companies in your database
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | String | No | Filter by organization name (contains) | Acme Corp |
| Location | String | No | Filter by location (contains) | New York |
| Website | String | No | Filter by website (contains) | https://acme.com |
| Visibility | Array | No | public, private, confidential | public |
| Creator ID(s) | String | No | Filter by user ID who created the organization | 42123 |
| Owner ID(s) | String | No | Filter by organization owner ID | 81245 |
| Created At (Start) | Date | No | Filter by created date greater than or equal to | 2025-01-01 |
| Created At (End) | Date | No | Filter by created date less than or equal to | 2025-06-30 |
| Updated At (Start) | Date | No | Filter by updated date greater than or equal to | 2025-11-01 |
| Updated At (End) | Date | No | Filter by updated date less than or equal to | 2025-11-30 |
| Page | Integer | No | Page number | 1 |
| Page Size | Integer | No | Results per page | 20 |
Stage ID(s) (stage__in) |
String | No | Comma-separated organization stage IDs returned by get_organization_stage. |
1,2 |
Expected Output
| Field Name | Example Values |
|---|---|
| Organization ID | 892 |
| Name | Acme Corp |
| Address | 456 Market St |
| Website | https://acme.com |
| Is Public | true |
| Is Visible | false |
| Description | Global provider of widgets and tech solutions |
| Owner ID | 81245 |
| Owner Name | John Doe |
| Logo | https://example/logo.png |
| Creator ID | 881242 |
| Creator Name | Mark Paul |
| Created At | 2025-06-30 |
| Updated At | 2025-06-15 |
| Website | https://example.com |
| Custom Fields | {"industry": "Tech", "tier": "Gold"} |
| Location | Bangkok |
Stage (stage) |
1 |
Stage ID (stage_id) |
1 |
Stage Name (stage_name) |
Qualified |
18. Create Organization
Create a new organization
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | String | Yes | Organization name | Acme Corp |
| Address | String | No | Street address | 456 Market St |
| Description | String | No | Description | Leading fintech company |
| Website | String | No | Website URL | https://acme.com |
| Owner ID | Integer | No | Owner user ID | 81245 |
| Custom Fields | Array | No | Custom field entries | [{"field_id":1,"value":"A"}] |
Expected Output
| Field Name | Example Values |
|---|---|
| Organization ID | 892 |
| Name | Acme Corp |
| Address | 456 Market St |
| Description | Leading provider of logistics solutions. |
| Website | https://acme.com |
| Owner ID | 81245 |
| Owner Name | John Doe |
| Is Public | true |
| Is Visible | false |
| Custom Fields | {"industry": "Tech", "tier": "Enterprise"} |
| Created At | 2025-10-01 |
| Updated At | 2025-10-05 |
19. Update Organization
Update an organization’s details.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
id |
integer | Yes | Organization ID | 1 |
external_id |
string or null | No | ID of the organization in the API consumer's systems. Maximum length: 255 | null |
name |
string | No | Name of the organization. Minimum length: 1. Maximum length: 255 | "Acme Corp" |
description |
string | No | Description of the organization | "Account details" |
owner |
integer or null | No | User ID from list_client_users to assign as the organization owner |
123 |
address |
string | No | Address of the organization | "123 Main Street" |
website |
string | No | Website of the organization. Maximum length: 255 | "https://example.com" |
custom_field_input |
array of objects | No | Values for the client's organization custom fields, as {"field": <slug>, "value": <value>} entries. Call get_organization_field first and take every field from a slug it returns: entries whose slug is unknown, or whose value the field rejects, are dropped silently and the rest of the update still succeeds. Only the fields listed here change; omitted fields keep their current value. |
[] |
custom_field_input[].field |
string | Yes | Exact, case-sensitive slug returned by the corresponding get-field tool. | "seniority" |
custom_field_input[].value |
string / number / boolean / array of values or null | Yes | Value matching the field definition and its allowed choices; null clears the field. | null |
Supply the required id and at least one update field. Omitted fields retain their current values.
Expected Output
Returns the updated record.
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
id |
integer | No | Record ID | 1 |
name |
string or null | No | name | "Acme Corp" |
description |
string or null | No | description | "Account details" |
logo |
string or null | No | logo | null |
creator |
integer or null | No | creator | 123 |
creator_name |
string or null | No | creator name | null |
owner |
integer or null | No | owner | 123 |
owner_id |
integer or null | No | owner id | 123 |
owner_name |
string or null | No | owner name | null |
location |
string or null | No | location | null |
address |
string or null | No | address | "123 Main Street" |
website |
string or null | No | website | "https://example.com" |
is_public |
boolean or null | No | is public | true |
is_visible |
boolean or null | No | is visible | true |
stage |
integer or null | No | stage | 1 |
stage_id |
integer or null | No | stage id | 1 |
stage_name |
string or null | No | stage name | "Qualified" |
custom_fields |
object or null | No | custom fields | {"seniority":"Senior"} |
created_at |
string or null (date-time) | No | Creation timestamp | "2026-10-19T09:00:00Z" |
updated_at |
string or null (date-time) | No | Last update timestamp | "2026-10-19T09:00:00Z" |
20. Get Organization Fields
List available organization fields and allowed values.
Possible Inputs
No parameters. Input: {}.
Expected Output
Returns a list of records.
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
groups |
array of objects | No | groups | [] |
groups[].name |
string or null | No | Group display name (e.g. "Personal Details"). Layout only — not part of any payload. | null |
groups[].is_hidden |
boolean | No | Whether the whole group is hidden from the client's profile view. | false |
groups[].fields |
array of objects | No | fields | [] |
groups[].fields[].slug |
string | No | Field identifier. Pass this verbatim as custom_field_input[].field; it is case-sensitive and must match exactly, so never guess, translate, or reformat it from the display name. |
"seniority" |
groups[].fields[].name |
string or null | No | Display name shown to recruiters — match user wording against this, then send slug. |
null |
groups[].fields[].description |
string or null | No | Help text explaining what the field is for. | null |
groups[].fields[].field_type |
string | No | Value type of the field: text, long_text, date (YYYY-MM-DD string), number, percentage, boolean, dropdown (single value), multiple_select_dropdown and checkbox (list of values), or custom_id (system-generated, never writable). |
"dropdown" |
groups[].fields[].answer_choices |
array of strings | No | Allowed values for dropdown, multiple_select_dropdown and checkbox fields when answer_choice_type is text. The written value must be one of these strings (or a list of them for multi-value fields); anything else is rejected. |
[] |
groups[].fields[].answer_choice_type |
string | No | text means the choices in answer_choices are the accepted values. Any other value (candidate, job, organization, contact, user) means the field stores the ID of another record instead, and answer_choices does not list the options. |
"text" |
groups[].fields[].is_required |
boolean | No | Whether the client requires this field to be filled. | false |
groups[].fields[].is_native |
boolean | No | true for built-in attributes (full_name, email, ...), which must be updated through the matching top-level parameter. Only fields with is_native: false can be written through custom_field_input. |
false |
groups[].fields[].is_hidden |
boolean | No | Whether the field is hidden from the client's profile view. | false |
21. Get Organization Stages
List organization stages.
Possible Inputs
No parameters. Input: {}.
Expected Output
Returns a list of records.
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
id |
integer | No | Organization stage ID | 1 |
name |
string or null | No | Stage display name | "Qualified" |
22. List Organization Notes
Read notes about a client company
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Organization ID | Integer | Yes | ID of the organization | 892 |
Expected Output
| Field Name | Example Values |
|---|---|
| Note ID | 4471 |
| Info | Key client, renew contract Q3 |
| Creator Name | Emma |
| Creator ID | 42241 |
| Created At | 2025-11-01 |
23. Add Organization Note
Record information about client relationships and interactions
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Organization ID | Integer | Yes | ID of the organization | 892 |
| Info | String | Yes | The content or information body (HTML supported) | Key client, renew contract Q3 |
Expected Output
| Field Name | Example Values |
|---|---|
| Note ID | 4471 |
| Info | Client requested a follow-up meeting next Tuesday. |
| Creator ID | 42241 |
| Creator Name | Emma |
| Created At | 2026-07-02 |
24. List Organization Activities
List activities linked to an organization.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Organization ID | Integer | Yes | ID of the organization. | 789 |
| Title Contains | String | No | Case-insensitive activity title filter. | interview |
| Activity Types | String | No | Comma-separated types: call, meeting, task, email, interview. | meeting,interview |
| Due Date (Start) | Date-time | No | At or after this UTC time. A bare date means midnight UTC. | 2026-11-05T00:00:00Z |
| Due Date (End) | Date-time | No | At or before this UTC time. Use 23:59:59Z to include the whole day; a bare date means midnight UTC. | 2026-11-05T23:59:59Z |
| Completed | Boolean | No | true for completed activities; false for open activities. | false |
| Creator IDs | String | No | Comma-separated creator user IDs. | 1,2 |
| Ordering | String | No | name, activity_type, due_date, created_at, or updated_at; prefix with - for descending. | due_date |
| Page | Integer | No | Page number. | 1 |
| Page Size | Integer | No | Results per page. | 20 |
Expected Output
| Field Name | Example Values |
|---|---|
| Activity ID | 456 |
| Name | Candidate interview |
| Description | Technical interview |
| Activity Type | interview |
| Linked Record Type | candidate |
| Linked Record ID | 123 |
| Linked Record Name | Jane Doe |
| Candidate ID (when linked to a match) | 123 |
| Start Time | 2026-11-05T03:00:00Z |
| Duration | 01:00:00 |
| Completed | false |
| Importance | normal |
| All Day | false |
| Location | Online |
| Online Meeting URL | https://example.com/meeting |
| Online Meeting Type | manual |
| Online Meeting Status | success |
| Creator ID | 1 |
| Creator Name | Alex Smith |
| Assignees → ID | 1 |
| Assignees → Name | Alex Smith |
| Assignees → Role | admin |
| Attendees → Candidate ID | 123 |
| Attendees → Candidate Name | Jane Doe |
| Attendees → Email | jane@example.com |
| Attendees → BCC | false |
| Created At | 2026-11-04T03:00:00Z |
| Updated At | 2026-11-04T03:00:00Z |
25. Search Contacts
Find people at client companies
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Full Name | String | No | Filter by full name (contains) | John Smith |
| Display Name | String | No | Filter by display name (contains) | J. Smith |
| String | No | Filter by email (contains) | john@acme.com | |
| Phone Number | String | No | Filter by phone number (contains) | +1-555-020-1234 |
| Organization ID(s) | String | No | Comma-separated organization IDs | 892 |
| Created At (Start) | Date | No | Filter by created date greater than or equal to | 2025-01-01 |
| Created At (End) | Date | No | Filter by created date less than or equal to | 2025-06-30 |
Expected Output
| Field Name | Example Values |
|---|---|
| Contact ID | 6621 |
| Full Name | John Smith |
| Display Name | J. Smith |
| john@acme.com | |
| Phone Number | +1-555-020-1234 |
| Organization Name | Acme Corp |
| Organization ID | 892 |
| Description | Key contact for the enterprise account |
| Custom Fields | {"priority": "high", "source": "referral"} |
| Creator ID | 1234 |
| Created At | 2025-06-30 |
User ID (user) |
123 or null |
Contact Type (type) |
contact or guest |
26. Update Contact
Update a contact’s details.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
id |
integer | Yes | Contact ID | 1 |
full_name |
string | No | Full name of the contact. Minimum length: 1. Maximum length: 255 | "John Smith" |
display_name |
string | No | Name to display, which can be different from the full name. Maximum length: 255 | "J. Smith" |
email |
string or null (email) | No | Contact email. Do not send this field when the contact type is guest; a guest contact is not allowed to edit its email. Maximum length: 254 |
"john@example.com" |
phone_number |
string | No | Contact phone number. Maximum length: 16 | "+66812345678" |
description |
string | No | Description of the contact | "Account details" |
custom_field_input |
array of objects | No | Values for the client's contact custom fields, as {"field": <slug>, "value": <value>} entries. Call get_contact_field first and take every field from a slug it returns: entries whose slug is unknown, or whose value the field rejects, are dropped silently and the rest of the update still succeeds. Only the fields listed here change; omitted fields keep their current value. |
[] |
custom_field_input[].field |
string | Yes | Exact, case-sensitive slug returned by the corresponding get-field tool. | "seniority" |
custom_field_input[].value |
string / number / boolean / array of values or null | Yes | Value matching the field definition and its allowed choices; null clears the field. | null |
Supply the required id and at least one update field. Omitted fields retain their current values.
Expected Output
Returns the updated record.
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
id |
integer | No | Record ID | 1 |
full_name |
string or null | No | full name | "John Smith" |
display_name |
string or null | No | display name | "J. Smith" |
email |
string or null | No | "john@example.com" |
|
phone_number |
string or null | No | phone number | "+66812345678" |
description |
string or null | No | description | "Account details" |
organization_name |
string or null | No | organization name | "Acme Corp" |
user |
integer or null | No | user | 123 |
creator |
integer or null | No | creator | 123 |
type |
string or null | No | Contact type. contact for a standalone contact, or guest. |
"contact" |
custom_fields |
object or null | No | custom fields | {"seniority":"Senior"} |
created_at |
string or null (date-time) | No | Creation timestamp | "2026-10-19T09:00:00Z" |
27. Get Contact Fields
List available contact fields and allowed values.
Possible Inputs
No parameters. Input: {}.
Expected Output
Returns a list of records.
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
groups |
array of objects | No | groups | [] |
groups[].name |
string or null | No | Group display name (e.g. "Personal Details"). Layout only — not part of any payload. | null |
groups[].is_hidden |
boolean | No | Whether the whole group is hidden from the client's profile view. | false |
groups[].fields |
array of objects | No | fields | [] |
groups[].fields[].slug |
string | No | Field identifier. Pass this verbatim as custom_field_input[].field; it is case-sensitive and must match exactly, so never guess, translate, or reformat it from the display name. |
"seniority" |
groups[].fields[].name |
string or null | No | Display name shown to recruiters — match user wording against this, then send slug. |
null |
groups[].fields[].description |
string or null | No | Help text explaining what the field is for. | null |
groups[].fields[].field_type |
string | No | Value type of the field: text, long_text, date (YYYY-MM-DD string), number, percentage, boolean, dropdown (single value), multiple_select_dropdown and checkbox (list of values), or custom_id (system-generated, never writable). |
"dropdown" |
groups[].fields[].answer_choices |
array of strings | No | Allowed values for dropdown, multiple_select_dropdown and checkbox fields when answer_choice_type is text. The written value must be one of these strings (or a list of them for multi-value fields); anything else is rejected. |
[] |
groups[].fields[].answer_choice_type |
string | No | text means the choices in answer_choices are the accepted values. Any other value (candidate, job, organization, contact, user) means the field stores the ID of another record instead, and answer_choices does not list the options. |
"text" |
groups[].fields[].is_required |
boolean | No | Whether the client requires this field to be filled. | false |
groups[].fields[].is_native |
boolean | No | true for built-in attributes (full_name, email, ...), which must be updated through the matching top-level parameter. Only fields with is_native: false can be written through custom_field_input. |
false |
groups[].fields[].is_hidden |
boolean | No | Whether the field is hidden from the client's profile view. | false |
28. List Contact Notes
Read notes about your client contacts
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Contact ID | Integer | Yes | ID of the contact | 6621 |
Expected Output
| Field Name | Example Values |
|---|---|
| Note ID | 8834 |
| Info | Prefers email over phone contact |
| Creator ID | 42241 |
| Creator Name | Emma |
| Created At | 2025-11-01 |
29. Add Contact Note
Record conversations or reminders about client contacts
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Contact ID | Integer | Yes | Contact ID | 123 |
| Info | String | Yes | Note to attach to contact | Meeting notes from the job requisition call. |
Expected Output
| Field Name | Example Values |
|---|---|
| Note ID | 452 |
| Info | Follow-up call scheduled for next Tuesday. |
| Creator ID | 12 |
| Creator Name | Emma |
| Created At | 2025-11-15 |
30. List Contact Meetings
List a contact’s AI Notetaker meetings and assessments.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Contact ID | Integer | Yes | Contact ID | 6621 |
| Page | Integer | No | Page number | 1 |
| Page Size | Integer | No | Results per page (max 10) | 10 |
Expected Output
Assessment contains JSON content when available; retrieve transcripts through Get Meeting.
| Field Name | Example Values |
|---|---|
| Meeting ID | 901 |
| Client ID | 123 |
| Activity ID | 7789 |
| Title | Candidate interview |
| Meeting Time | 2026-09-22T09:00:00Z |
| Meeting URL | null |
| Is Guest Shared | false |
| Is Archived | false |
| Created At | 2026-09-22T09:00:00Z |
| Updated At | 2026-09-22T09:00:00Z |
| Job ID | 5567 |
| Candidate ID | 10234 |
| Status | completed |
| Source Type | ai_notetaker |
| Duration | 1800 |
| Assessment | null |
31. List Contact Activities
List activities linked to a contact.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Contact ID | Integer | Yes | ID of the contact. | 654 |
| Title Contains | String | No | Case-insensitive activity title filter. | interview |
| Activity Types | String | No | Comma-separated types: call, meeting, task, email, interview. | meeting,interview |
| Due Date (Start) | Date-time | No | At or after this UTC time. A bare date means midnight UTC. | 2026-11-05T00:00:00Z |
| Due Date (End) | Date-time | No | At or before this UTC time. Use 23:59:59Z to include the whole day; a bare date means midnight UTC. | 2026-11-05T23:59:59Z |
| Completed | Boolean | No | true for completed activities; false for open activities. | false |
| Creator IDs | String | No | Comma-separated creator user IDs. | 1,2 |
| Ordering | String | No | name, activity_type, due_date, created_at, or updated_at; prefix with - for descending. | due_date |
| Page | Integer | No | Page number. | 1 |
| Page Size | Integer | No | Results per page. | 20 |
Expected Output
| Field Name | Example Values |
|---|---|
| Activity ID | 456 |
| Name | Candidate interview |
| Description | Technical interview |
| Activity Type | interview |
| Linked Record Type | candidate |
| Linked Record ID | 123 |
| Linked Record Name | Jane Doe |
| Candidate ID (when linked to a match) | 123 |
| Start Time | 2026-11-05T03:00:00Z |
| Duration | 01:00:00 |
| Completed | false |
| Importance | normal |
| All Day | false |
| Location | Online |
| Online Meeting URL | https://example.com/meeting |
| Online Meeting Type | manual |
| Online Meeting Status | success |
| Creator ID | 1 |
| Creator Name | Alex Smith |
| Assignees → ID | 1 |
| Assignees → Name | Alex Smith |
| Assignees → Role | admin |
| Attendees → Candidate ID | 123 |
| Attendees → Candidate Name | Jane Doe |
| Attendees → Email | jane@example.com |
| Attendees → BCC | false |
| Created At | 2026-11-04T03:00:00Z |
| Updated At | 2026-11-04T03:00:00Z |
32. Search Jobs
Find open positions by role, status, or company
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Position Name | String | No | Filter by job title (contains) | Senior Developer |
| Organization Name | String | No | Filter by org name (contains) | Acme Corp |
| City | String | No | Filter by city (contains) | New York |
| Status | String | No | Comma-separated: planning, active, on_hold, won, lost | active |
| Is Published | Boolean | No | Filter by career-page published status | true |
| Is Remote | Boolean | No | Filter by remote work option | true |
| Creator ID(s) | String | No | Comma-separated creator IDs | 42123 |
| Owner ID(s) | String | No | Comma-separated owner IDs | 81245 |
| Open At (Start) | Date | No | Filter by open date greater than or equal to | 2025-01-01 |
| Open At (End) | Date | No | Filter by open date less than or equal to | 2025-06-30 |
| Close At (Start) | Date | No | Filter by close date greater than or equal to | 2025-07-01 |
| Close At (End) | Date | No | Filter by close date less than or equal to | 2025-12-31 |
| Created At (Start) | Date | No | Filter by created date greater than or equal to | 2025-01-01 |
| Created At (End) | Date | No | Filter by created date less than or equal to | 2025-06-30 |
| Updated At (Start) | Date | No | Filter by updated date greater than or equal to | 2025-11-01 |
| Updated At (End) | Date | No | Filter by updated date less than or equal to | 2025-11-30 |
| Page | Integer | No | Page number | 1 |
| Page Size | Integer | No | Results per page | 20 |
Expected Output
| Field Name | Example Values |
|---|---|
| Job ID | 419258 |
| Organization ID | 1495136 |
| Organization Name | Acme Corp |
| Position Name | Senior Developer |
| Description | Analyze large datasets to drive business strategies. |
| Headcount | 1 |
| Is Remote | True |
| Creator ID | 123 |
| Creator Name | Emma |
| Owner ID | 456 |
| Owner Name | John |
| State | Indiana |
| City | Georgia |
| Address | Indiana |
| Zip Code | 10119 |
| Salary Min | 80000 |
| Salary Max | 100000 |
| Currency | 1 |
| Currency Code | USD |
| Frequency | monthly |
| Contract Details | full_time |
| Is Published | true |
| Status | active |
| Created At | 2026-04-09T09:54:37.629221Z |
| Updated At | 2026-04-09T09:54:58.982897Z |
| Open At | 2026-04-09T09:54:37.614247Z |
| Close At | null |
| Custom Fields | {"department": "Analytics", "priority": "high"} |
| Industry | Charity / Social Services / Non- Profit Organization |
| Is Pinned In Career Page | false |
33. Create Job
Add a new position you're looking to fill
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Organization ID | Integer | Yes | Organization the job belongs to | 892 |
| Position Name | String | Yes | Job title | Senior Developer |
| Address | String | No | Job location street address | 456 Market St |
| Zip Code | String | No | Postal/zip code | 10001 |
| Contract Details | String | No | Options: full_time, part_time, temporary, freelance, internship, apprenticeship, contractor, consultancy. | full_time |
| Currency ID | Integer | No | Currency ID for salary | 1 |
| Salary Min | Number | No | Minimum salary | 90000 |
| Salary Max | Number | No | Maximum salary | 130000 |
| Headcount | Integer | No | Number of positions to fill | 2 |
| Description | String | No | Job description (HTML supported) | We are looking for… |
| Industry | Array | No | List of industry IDs | [3,7] |
| Is Remote | Boolean | No | Whether job is remote | true |
| Is Published | Boolean | No | Published on career page | true |
| Is Pinned in Career Page | Boolean | No | Whether the job has been added to the career page or not | false |
| Owner ID | Integer | No | Owner user ID | 81245 |
| Status | String | No | planning, active, on_hold, won, lost | active |
| Custom Fields | Array | No | Job values for custom fields defined in Manatal | {"department": "Analytics", "priority": "high"} |
Expected Output
| Field Name | Example Values |
|---|---|
| Job ID | 419258 |
| Organization ID | 1495136 |
| Organization Name | Acme Corp |
| Position Name | Senior Developer |
| Description | Analyze large datasets to drive business strategies. |
| Headcount | 1 |
| Is Remote | null |
| Creator ID | 123 |
| Creator Name | Emma |
| Owner ID | 456 |
| Owner Name | John |
| State | Indiana |
| City | Georgia |
| Address | Indiana |
| Zip Code | 10119 |
| Salary Min | 80000 |
| Salary Max | 100000 |
| Currency ID | 1 |
| Currency Code | USD |
| Frequency | day |
| Contract Details | full_time |
| Is Published | true |
| Status | active |
| Created At | 2026-04-09T09:54:37.629221Z |
| Updated At | 2026-04-09T09:54:58.982897Z |
| Open At | 2026-04-09T09:54:37.614247Z |
| Close At | 2026-04-09T09:54:37.614247Z |
| Custom Fields | {"department": "Analytics", "priority": "high"} |
| Industry | Charity / Social Services / Non- Profit Organization |
| Is Pinned In Career Page | false |
34. Get Job
Get a job’s full details by ID
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Job ID | Integer | Yes | ID of the job to retrieve | 5567 |
Expected Output
| Field Name | Example Values |
|---|---|
| Job ID | 419258 |
| Organization ID | 1495136 |
| Organization Name | Acme Corp |
| Position Name | Senior Developer |
| Description | Analyze large datasets to drive business strategies. |
| Headcount | 1 |
| Is Remote | null |
| Creator ID | 123 |
| Creator Name | Emma |
| Owner ID | 456 |
| Owner Name | John |
| State | Indiana |
| City | Georgia |
| Address | Indiana |
| Zip Code | 10119 |
| Salary Min | 80000 |
| Salary Max | 100000 |
| Currency ID | 1 |
| Currency Code | USD |
| Frequency | monthly |
| Contract Details | full_time |
| Is Published | true |
| Status | active |
| Created At | 2026-04-09T09:54:37.629221Z |
| Updated At | 2026-04-09T09:54:58.982897Z |
| Open At | 2026-04-09T09:54:37.614247Z |
| Close At | null |
| Custom Fields | {"department": "Analytics", "priority": "high"} |
| Industry | Charity / Social Services / Non- Profit Organization |
| Is Pinned In Career Page | false |
35. Update Job
Update a job’s details.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
id |
integer | Yes | Job ID | 1 |
external_id |
string or null | No | ID of the job in the API consumer systems. Maximum length: 255 | null |
position_name |
string | No | Job title. Minimum length: 1. Maximum length: 255 | "Software Engineer" |
description |
string | No | Description of the job | "Account details" |
headcount |
integer or null | No | Number of people to be hired for the job. Minimum: 0. Maximum: 2147483647 | 3 |
is_salary_visible |
boolean | No | Whether salary information is displayed to candidates on the career page and job postings. | false |
salary_min |
string or null (decimal) | No | salary min | 50000 |
salary_max |
string or null (decimal) | No | salary max | 70000 |
frequency |
string or null | No | frequency | "monthly" |
currency |
integer or null | No | Currency ID from list_currencies |
1 |
industries |
integer or null | No | Industry ID from list_industries |
null |
owner |
integer or null | No | User ID from list_client_users to assign as the job owner |
123 |
address |
string | No | Address of the office where the job will take place. Maximum length: 255 | "123 Main Street" |
city |
string | No | City of the office the job will take place. Maximum length: 255 | "Bangkok" |
state |
string | No | State of the office the job will take place. Maximum length: 255 | "Bangkok" |
country |
string | No | Country of the office the job will take place. Maximum length: 255 | "Example" |
Zip Code |
string | No | Postal/zip code of the office address. Maximum length: 255 | "10110" |
contract_details |
string | No | Contract details. Allowed values: full_time, part_time, temporary, freelance, internship, apprenticeship, contractor, consultancy | "full_time" |
is_published |
boolean | No | is published | true |
is_remote |
boolean or null | No | is remote | true |
status |
string | No | Status of the job. Allowed values: active, on_hold, won, lost | "active" |
expected_close_at |
string (date-time) | No | Expected date when the job position will be closed/filled | "2026-10-19T09:00:00Z" |
custom_field_input |
array of objects | No | Values for the client's job custom fields, as {"field": <slug>, "value": <value>} entries. Call get_job_field first and take every field from a slug it returns: entries whose slug is unknown, or whose value the field rejects, are dropped silently and the rest of the update still succeeds. Only the fields listed here change; omitted fields keep their current value. |
[] |
custom_field_input[].field |
string | Yes | Exact, case-sensitive slug returned by the corresponding get-field tool. | "seniority" |
custom_field_input[].value |
string / number / boolean / array of values or null | Yes | Value matching the field definition and its allowed choices; null clears the field. | null |
is_pinned_in_career_page |
boolean | No | Whether the job has been added to the career page or not | false |
Supply the required id and at least one update field. Omitted fields retain their current values.
Expected Output
Returns the updated record.
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
id |
integer | No | Record ID | 1 |
organization |
integer or null | No | organization | null |
organization_name |
string or null | No | organization name | "Acme Corp" |
position_name |
string or null | No | position name | "Software Engineer" |
description |
string or null | No | description | "Account details" |
headcount |
integer or null | No | headcount | 3 |
is_remote |
boolean or null | No | is remote | true |
creator |
integer or null | No | creator | 123 |
creator_name |
string or null | No | creator name | null |
owner |
integer or null | No | owner | 123 |
owner_name |
string or null | No | owner name | null |
state |
string or null | No | state | "Bangkok" |
city |
string or null | No | city | "Bangkok" |
address |
string or null | No | address | "123 Main Street" |
Zip Code |
string or null | No | Zip Code | "10110" |
salary_min |
number or null | No | salary min | 50000 |
salary_max |
number or null | No | salary max | 70000 |
currency |
integer or null | No | currency | 1 |
currency_code |
string or null | No | currency code | "USD" |
frequency |
string or null | No | frequency | "monthly" |
contract_details |
string or null | No | contract details | "full_time" |
is_published |
boolean or null | No | is published | true |
status |
string or null | No | status | "active" |
created_at |
string or null (date-time) | No | Creation timestamp | "2026-10-19T09:00:00Z" |
updated_at |
string or null (date-time) | No | Last update timestamp | "2026-10-19T09:00:00Z" |
open_at |
string or null (date-time) | No | open at | "2026-10-19T09:00:00Z" |
close_at |
string or null (date-time) | No | close at | "2026-11-19T09:00:00Z" |
custom_fields |
object or null | No | custom fields | {"seniority":"Senior"} |
industries_name |
string or null | No | industries name | null |
is_pinned_in_career_page |
boolean or null | No | is pinned in career page | null |
36. Get Job Fields
List available job fields and allowed values.
Possible Inputs
No parameters. Input: {}.
Expected Output
Returns a list of records.
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
groups |
array of objects | No | groups | [] |
groups[].name |
string or null | No | Group display name (e.g. "Personal Details"). Layout only — not part of any payload. | null |
groups[].is_hidden |
boolean | No | Whether the whole group is hidden from the client's profile view. | false |
groups[].fields |
array of objects | No | fields | [] |
groups[].fields[].slug |
string | No | Field identifier. Pass this verbatim as custom_field_input[].field; it is case-sensitive and must match exactly, so never guess, translate, or reformat it from the display name. |
"seniority" |
groups[].fields[].name |
string or null | No | Display name shown to recruiters — match user wording against this, then send slug. |
null |
groups[].fields[].description |
string or null | No | Help text explaining what the field is for. | null |
groups[].fields[].field_type |
string | No | Value type of the field: text, long_text, date (YYYY-MM-DD string), number, percentage, boolean, dropdown (single value), multiple_select_dropdown and checkbox (list of values), or custom_id (system-generated, never writable). |
"dropdown" |
groups[].fields[].answer_choices |
array of strings | No | Allowed values for dropdown, multiple_select_dropdown and checkbox fields when answer_choice_type is text. The written value must be one of these strings (or a list of them for multi-value fields); anything else is rejected. |
[] |
groups[].fields[].answer_choice_type |
string | No | text means the choices in answer_choices are the accepted values. Any other value (candidate, job, organization, contact, user) means the field stores the ID of another record instead, and answer_choices does not list the options. |
"text" |
groups[].fields[].is_required |
boolean | No | Whether the client requires this field to be filled. | false |
groups[].fields[].is_native |
boolean | No | true for built-in attributes (full_name, email, ...), which must be updated through the matching top-level parameter. Only fields with is_native: false can be written through custom_field_input. |
false |
groups[].fields[].is_hidden |
boolean | No | Whether the field is hidden from the client's profile view. | false |
37. List Job Notes
Read notes and updates about a job opening
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Job ID | Integer | Yes | ID of the job | 5567 |
Expected Output
| Field Name | Example Values |
|---|---|
| Note ID | 7789 |
| Info | Client wants to move fast on this role |
| Creator ID | 42241 |
| Creator Name | Emma |
| Created At | 2025-11-01 |
38. Add Job Note
Record updates, requirements, or hiring progress
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Job ID | Integer | Yes | ID of the job | 5567 |
| Info | String | Yes | The content or information body of the note | Client wants to move fast on this role |
Expected Output
| Field Name | Example Values |
|---|---|
| Note ID | 7789 |
| Info | Client wants to move fast on this role |
| Creator ID | 42241 |
| Creator Name | Emma |
| Created At | 2026-07-02 |
39. List Job Meetings
List a job’s AI Interviewer meetings and assessments.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Job ID | Integer | Yes | Job ID | 5567 |
| Page | Integer | No | Page number | 1 |
| Page Size | Integer | No | Results per page (max 10). | 10 |
Expected Output
Assessment contains JSON content when available; retrieve transcripts through Get Meeting.
| Field Name | Example Values |
|---|---|
| Meeting ID | 901 |
| Client ID | 123 |
| Activity ID | 7789 |
| Title | Candidate interview |
| Meeting Time | 2026-09-22T09:00:00Z |
| Meeting URL | null |
| Is Guest Shared | false |
| Is Archived | false |
| Created At | 2026-09-22T09:00:00Z |
| Updated At | 2026-09-22T09:00:00Z |
| Job ID | 5567 |
| Candidate ID | 10234 |
| Status | completed |
| Source Type | ai_interviewer |
| Duration | 1800 |
| Assessment | null |
40. List Job Activities
List activities linked to a job.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Job ID | Integer | Yes | ID of the job. | 456 |
| Title Contains | String | No | Case-insensitive activity title filter. | interview |
| Activity Types | String | No | Comma-separated types: call, meeting, task, email, interview. | meeting,interview |
| Due Date (Start) | Date-time | No | At or after this UTC time. A bare date means midnight UTC. | 2026-11-05T00:00:00Z |
| Due Date (End) | Date-time | No | At or before this UTC time. Use 23:59:59Z to include the whole day; a bare date means midnight UTC. | 2026-11-05T23:59:59Z |
| Completed | Boolean | No | true for completed activities; false for open activities. | false |
| Creator IDs | String | No | Comma-separated creator user IDs. | 1,2 |
| Ordering | String | No | name, activity_type, due_date, created_at, or updated_at; prefix with - for descending. | due_date |
| Page | Integer | No | Page number. | 1 |
| Page Size | Integer | No | Results per page. | 20 |
Expected Output
| Field Name | Example Values |
|---|---|
| Activity ID | 456 |
| Name | Candidate interview |
| Description | Technical interview |
| Activity Type | interview |
| Linked Record Type | candidate |
| Linked Record ID | 123 |
| Linked Record Name | Jane Doe |
| Candidate ID (when linked to a match) | 123 |
| Start Time | 2026-11-05T03:00:00Z |
| Duration | 01:00:00 |
| Completed | false |
| Importance | normal |
| All Day | false |
| Location | Online |
| Online Meeting URL | https://example.com/meeting |
| Online Meeting Type | manual |
| Online Meeting Status | success |
| Creator ID | 1 |
| Creator Name | Alex Smith |
| Assignees → ID | 1 |
| Assignees → Name | Alex Smith |
| Assignees → Role | admin |
| Attendees → Candidate ID | 123 |
| Attendees → Candidate Name | Jane Doe |
| Attendees → Email | jane@example.com |
| Attendees → BCC | false |
| Created At | 2026-11-04T03:00:00Z |
| Updated At | 2026-11-04T03:00:00Z |
41. Search Matches
See which candidates have been matched to which jobs and their progress
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Job ID(s) | String | No | Comma-separated job IDs | 5567 |
| Match Stage ID(s) | String | No | Comma-separated match stage IDs (from list_match_stages) | 3 |
| Created At (Start) | Date | No | Filter by created date greater than or equal to | 2025-01-01 |
| Created At (End) | Date | No | Filter by created date less than or equal to | 2025-06-30 |
| Updated At (Start) | Date | No | Filter by updated date greater than or equal to | 2025-11-01 |
| Updated At (End) | Date | No | Filter by updated date less than or equal to | 2025-11-30 |
| Submitted At (Start) | Date | No | Filter by submitted date greater than or equal to | 2026-01-01 |
| Submitted At (End) | Date | No | Filter by submitted date less than or equal to | 2026-01-31 |
| Interview At (Start) | Date | No | Filter by interview date greater than or equal to | 2026-01-10 |
| Interview At (End) | Date | No | Filter by interview date less than or equal to | 2026-01-20 |
| Offer At (Start) | Date | No | Filter by offer date less than or equal to | 2026-02-01 |
| Offer At (End) | Date | No | Filter by offer date less than or equal to | 2026-02-10 |
| Hired At (Start) | Date | No | Filter by hired date greater than or equal to | 2026-02-15 |
| Hired At (End) | Date | No | Filter by hired date less than or equal to | 2026-02-28 |
| Dropped At (Start) | Date | No | Filter by dropped date greater than or equal to | 2026-02-28 |
| Dropped At (End) | Date | No | Filter by dropped date less than or equal to | 2026-02-28 |
| Page | Integer | No | Page number | 1 |
| Page Size | Integer | No | Results per page | 20 |
Expected Output
| Field Name | Example Values |
|---|---|
| Match ID | 77120 |
| Candidate ID | 10234 |
| Job ID | 5567 |
| Owner ID | 123 |
| Creator ID | 456 |
| Match Stage | Interview |
| Is Active | true |
| Hired At | 2026-01-30 |
| Submitted At | 2026-01-10 |
| Interview At | 2026-01-15 |
| Offer At | 2026-01-20 |
| Dropped At | 2026-01-15 |
| Created At | 2026-01-10 |
| Updated At | 2026-01-15 |
42. Get Match
Get a match’s details by ID
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Match ID | Integer | Yes | ID of the match | 77120 |
Expected Output
43. Add Candidate to Job
Connect a candidate with a job opening
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Candidate ID | Integer | Yes | Candidate to add | 10234 |
| Job ID | Integer | Yes | Job the candidate is matched with | 5567 |
| Is Active | Boolean | No | Whether the match is still active or not | true |
| Submitted At | DateTime | No | Date at which the candidate was added to the job | 2026-01-10T00:00:00Z |
| Interview At | DateTime | No | Date at which the candidate was last interviewed | 2026-01-15T00:00:00Z |
| Offer At | DateTime | No | Date at which an offer was made to the candidate | 2026-02-01T00:00:00Z |
| Hired At | DateTime | No | Date at which the candidate was hired | 2026-02-15T00:00:00Z |
| Dropped At | DateTime | No | Date at which the candidate was no longer considered for the job. | (null) |
Expected Output
44. List Match Stages
List available candidate-job pipeline stages.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| (none — no parameters) | — | — | — | — |
Expected Output
45. Get Job Match Stages
Retrieve a job’s pipeline stages and their configuration.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Job ID | Integer | Yes | Job ID | 5567 |
Expected Output
| Field Name | Example Values |
|---|---|
| Job Pipeline Stage ID | 3 |
| Name | Submitted |
| Category | submitted_stage |
| Has Automation Action | false |
| Key Stages | ["submitted_stage"] |
46. List Drop Reasons
List the client’s reasons for dropping candidates from job pipelines.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Ordering | String | No | Which field to use when ordering the results. | id |
Expected Output
47. List Dropped Candidates
List dropped candidates for a specific job pipeline stage.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Job ID | Integer | Yes | Job ID | 5567 |
| Stage ID | Integer | Yes | Job pipeline stage ID (from get_job_match_stage). Restricts results to dropped matches on that stage. | 3 |
| Search | String | No | Search by candidate full name or email | Jane |
| Page | Integer | No | A page number within the paginated result set. | 1 |
| Page Size | Integer | No | Number of results to return per page. | 10 |
| Ordering | String | No | Order results. Prefix with '-' for descending. | id |
Expected Output
Each item represents a dropped match; its Match ID differs from the Candidate ID.
| Field Name | Example Values |
|---|---|
| Match ID | 77120 |
| Candidate → Candidate ID | 10234 |
| Candidate → Full Name | Jane Doe |
| Candidate → Email | jane.doe@example.com |
| Candidate → Picture | null |
| Job → Job ID | 5567 |
| Drop Reasons | ["Skills mismatch"] |
48. Bulk Move Matches
Move one or more active matches to another job pipeline stage.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Job ID | Integer | Yes | Job ID | 5567 |
| Match ID List | Array | Yes | Match IDs to move | [77120,77121] |
| Job Pipeline Stage ID | Integer | Yes | Target job pipeline stage ID from get_job_match_stage | 3 |
Expected Output
49. Bulk Drop Matches
Drop one or more active matches from a job pipeline.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Job ID | Integer | Yes | Job ID | 5567 |
| Match ID List | Array | Yes | Match IDs to drop | [77120,77121] |
| Drop Reason ID List | Array | Yes | Drop reason IDs from list_drop_reasons | [2] |
| Info | String | No | Optional HTML note text attached to each dropped match | Candidate does not meet the role requirements. |
Expected Output
50. List Match Activities
List activities linked to a match (a candidate on a job).
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Match ID | Integer | Yes | ID of the candidate-job match. | 321 |
| Title Contains | String | No | Case-insensitive activity title filter. | interview |
| Activity Types | String | No | Comma-separated types: call, meeting, task, email, interview. | meeting,interview |
| Due Date (Start) | Date-time | No | At or after this UTC time. A bare date means midnight UTC. | 2026-11-05T00:00:00Z |
| Due Date (End) | Date-time | No | At or before this UTC time. Use 23:59:59Z to include the whole day; a bare date means midnight UTC. | 2026-11-05T23:59:59Z |
| Completed | Boolean | No | true for completed activities; false for open activities. | false |
| Creator IDs | String | No | Comma-separated creator user IDs. | 1,2 |
| Ordering | String | No | name, activity_type, due_date, created_at, or updated_at; prefix with - for descending. | due_date |
| Page | Integer | No | Page number. | 1 |
| Page Size | Integer | No | Results per page. | 20 |
Expected Output
| Field Name | Example Values |
|---|---|
| Activity ID | 456 |
| Name | Candidate interview |
| Description | Technical interview |
| Activity Type | interview |
| Linked Record Type | candidate |
| Linked Record ID | 123 |
| Linked Record Name | Jane Doe |
| Candidate ID (when linked to a match) | 123 |
| Start Time | 2026-11-05T03:00:00Z |
| Duration | 01:00:00 |
| Completed | false |
| Importance | normal |
| All Day | false |
| Location | Online |
| Online Meeting URL | https://example.com/meeting |
| Online Meeting Type | manual |
| Online Meeting Status | success |
| Creator ID | 1 |
| Creator Name | Alex Smith |
| Assignees → ID | 1 |
| Assignees → Name | Alex Smith |
| Assignees → Role | admin |
| Attendees → Candidate ID | 123 |
| Attendees → Candidate Name | Jane Doe |
| Attendees → Email | jane@example.com |
| Attendees → BCC | false |
| Created At | 2026-11-04T03:00:00Z |
| Updated At | 2026-11-04T03:00:00Z |
51. Create Activity
Create a call, meeting, task, email, or interview.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | String | Yes | Activity title; maximum 255 characters. | Candidate interview |
| Description | String or null | No | Notes or agenda; HTML is sanitized. | Technical interview |
| Activity Type | String | No | call, meeting, task, email, or interview. | interview |
| Linked Record Type | String or null | No | candidate, organization, job, match, or contact. Set together with Linked Record ID. | candidate |
| Linked Record ID | Integer or null | No | ID of the linked record; set together with Linked Record Type. | 123 |
| Start Time | Date-time or null | No | Calendar start time in ISO-8601 UTC. | 2026-11-05T03:00:00Z |
| Duration | String or null | No | Activity length as HH:MM:SS. | 01:00:00 |
| Completed | Boolean | No | Whether the activity is completed. | false |
| Importance | String | No | low, normal, or high; defaults to normal. | normal |
| All Day | Boolean | No | Whether the activity lasts all day. | false |
| Location | String or null | No | Where the activity takes place. | Online |
| Online Meeting Type | String | No | google_meet or microsoft_teams generates a link when the calendar is connected; manual uses the supplied URL. | manual |
| Online Meeting URL | String or null | No | Meeting URL when meeting type is manual. | https://example.com/meeting |
| Timezone | String | No | IANA timezone; defaults to UTC. | Asia/Bangkok |
| Assignee IDs | Array of integers | No | User IDs from List Client Users. On update, replaces all assignees; include everyone who should remain. | 1, 2 |
| Attendees | Array of objects | No | Each attendee requires BCC and is identified by email or candidate ID. On update, replaces all attendees; include everyone who should remain. | Candidate ID: 123; BCC: false |
| Attendee → Email | String or null | No | Email address of an external attendee. | jane@example.com |
| Attendee → Candidate ID | Integer or null | No | Candidate ID; use the candidate ID returned on an attendee by Get Activity. | 123 |
| Attendee → BCC | Boolean | Yes, per attendee | Whether the attendee is BCC. | false |
| Invite AI Notetaker | Boolean | No | Set true to invite AI Notetaker. Adds meeting@manatal.com as a non-BCC attendee without duplicating it. | true |
Expected Output
| Field Name | Example Values |
|---|---|
| Activity ID | 456 |
| Name | Candidate interview |
| Description | Technical interview |
| Activity Type | interview |
| Linked Record Type | candidate |
| Linked Record ID | 123 |
| Linked Record Name | Jane Doe |
| Candidate ID (when linked to a match) | 123 |
| Start Time | 2026-11-05T03:00:00Z |
| Duration | 01:00:00 |
| Completed | false |
| Importance | normal |
| All Day | false |
| Location | Online |
| Online Meeting URL | https://example.com/meeting |
| Online Meeting Type | manual |
| Online Meeting Status | success |
| Creator ID | 1 |
| Creator Name | Alex Smith |
| Assignees → ID | 1 |
| Assignees → Name | Alex Smith |
| Assignees → Role | admin |
| Attendees → Candidate ID | 123 |
| Attendees → Candidate Name | Jane Doe |
| Attendees → Email | jane@example.com |
| Attendees → BCC | false |
| Created At | 2026-11-04T03:00:00Z |
| Updated At | 2026-11-04T03:00:00Z |
52. Get Activity
Get an activity’s details, assignees, and attendees.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Activity ID | Integer | Yes | ID of the activity. | 456 |
Expected Output
| Field Name | Example Values |
|---|---|
| Activity ID | 456 |
| Name | Candidate interview |
| Description | Technical interview |
| Activity Type | interview |
| Linked Record Type | candidate |
| Linked Record ID | 123 |
| Linked Record Name | Jane Doe |
| Candidate ID (when linked to a match) | 123 |
| Start Time | 2026-11-05T03:00:00Z |
| Duration | 01:00:00 |
| Completed | false |
| Importance | normal |
| All Day | false |
| Location | Online |
| Online Meeting URL | https://example.com/meeting |
| Online Meeting Type | manual |
| Online Meeting Status | success |
| Creator ID | 1 |
| Creator Name | Alex Smith |
| Assignees → ID | 1 |
| Assignees → Name | Alex Smith |
| Assignees → Role | admin |
| Attendees → Candidate ID | 123 |
| Attendees → Candidate Name | Jane Doe |
| Attendees → Email | jane@example.com |
| Attendees → BCC | false |
| Created At | 2026-11-04T03:00:00Z |
| Updated At | 2026-11-04T03:00:00Z |
53. Update Activity
Update selected activity details, completion, assignees, or attendees.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Activity ID | Integer | Yes | ID of the activity. | 456 |
| Name | String | No | Activity title; maximum 255 characters. | Candidate interview |
| Description | String or null | No | Notes or agenda; HTML is sanitized. | Technical interview |
| Activity Type | String | No | call, meeting, task, email, or interview. | interview |
| Linked Record Type | String or null | No | candidate, organization, job, match, or contact. Set together with Linked Record ID. | candidate |
| Linked Record ID | Integer or null | No | ID of the linked record; set together with Linked Record Type. | 123 |
| Start Time | Date-time or null | No | Calendar start time in ISO-8601 UTC. | 2026-11-05T03:00:00Z |
| Duration | String or null | No | Activity length as HH:MM:SS. | 01:00:00 |
| Completed | Boolean | No | Whether the activity is completed. | false |
| Importance | String | No | low, normal, or high; defaults to normal. | normal |
| All Day | Boolean | No | Whether the activity lasts all day. | false |
| Location | String or null | No | Where the activity takes place. | Online |
| Online Meeting Type | String | No | google_meet or microsoft_teams generates a link when the calendar is connected; manual uses the supplied URL. | manual |
| Online Meeting URL | String or null | No | Meeting URL when meeting type is manual. | https://example.com/meeting |
| Timezone | String | No | IANA timezone; defaults to UTC. | Asia/Bangkok |
| Assignee IDs | Array of integers | No | User IDs from List Client Users. On update, replaces all assignees; include everyone who should remain. | 1, 2 |
| Attendees | Array of objects | No | Each attendee requires BCC and is identified by email or candidate ID. On update, replaces all attendees; include everyone who should remain. | Candidate ID: 123; BCC: false |
| Attendee → Email | String or null | No | Email address of an external attendee. | jane@example.com |
| Attendee → Candidate ID | Integer or null | No | Candidate ID; use the candidate ID returned on an attendee by Get Activity. | 123 |
| Attendee → BCC | Boolean | Yes, per attendee | Whether the attendee is BCC. | false |
| Invite AI Notetaker | Boolean | No | Set true to invite AI Notetaker. Adds meeting@manatal.com as a non-BCC attendee without duplicating it. | true |
Only supplied fields are changed. Supplied assignee and attendee lists replace the complete existing lists. When inviting AI Notetaker, include every other attendee who should remain.
Expected Output
| Field Name | Example Values |
|---|---|
| Activity ID | 456 |
| Name | Candidate interview |
| Description | Technical interview |
| Activity Type | interview |
| Linked Record Type | candidate |
| Linked Record ID | 123 |
| Linked Record Name | Jane Doe |
| Candidate ID (when linked to a match) | 123 |
| Start Time | 2026-11-05T03:00:00Z |
| Duration | 01:00:00 |
| Completed | false |
| Importance | normal |
| All Day | false |
| Location | Online |
| Online Meeting URL | https://example.com/meeting |
| Online Meeting Type | manual |
| Online Meeting Status | success |
| Creator ID | 1 |
| Creator Name | Alex Smith |
| Assignees → ID | 1 |
| Assignees → Name | Alex Smith |
| Assignees → Role | admin |
| Attendees → Candidate ID | 123 |
| Attendees → Candidate Name | Jane Doe |
| Attendees → Email | jane@example.com |
| Attendees → BCC | false |
| Created At | 2026-11-04T03:00:00Z |
| Updated At | 2026-11-04T03:00:00Z |
54. Get Meeting
Retrieve a meeting’s details, assessment, and transcript.
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Meeting ID | Integer | Yes | Meeting ID | 901 |
Expected Output
Assessment and Transcript contain JSON content when available; null means no content is returned for that field.
| Field Name | Example Values |
|---|---|
| Meeting ID | 901 |
| Client ID | 123 |
| Activity ID | 7789 |
| Title | Candidate interview |
| Meeting Time | 2026-09-22T09:00:00Z |
| Meeting URL | null |
| Is Guest Shared | false |
| Is Archived | false |
| Created At | 2026-09-22T09:00:00Z |
| Updated At | 2026-09-22T09:00:00Z |
| Job ID | 5567 |
| Candidate ID | 10234 |
| Status | completed |
| Source Type | ai_interviewer |
| Duration | 1800 |
| Assessment | null |
| Transcript | null |
55. Search Employers
Search employers by name to look up employer IDs
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Search Term | String | Yes | Employer name search (min 3 chars) | Tech Solutions |
| Query Limit | Integer | No | Results per page (1-100, default 20) | 20 |
Expected Output
| Field Name | Example Values |
|---|---|
| Employer ID | 771 |
| Name | Tech Solutions Inc. |
56. Create Employer
Create a new employer by name
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | String | Yes | Employer name | Acme Corp |
Expected Output
| Field Name | Example Values |
|---|---|
| Employer ID | 892 |
| Name | Acme Corp |
57. Search Positions
Search job titles by name to look up position IDs
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Search Term | String | Yes | Position name search (min 3 chars) | Developer |
| Query Limit | Integer | No | Results per page (1-100, default 20) | 20 |
Expected Output
| Field Name | Example Values |
|---|---|
| Position ID | 220 |
| Name | Senior Developer |
58. Create Position
Create a new job position by name
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | String | Yes | Position/job title name | Product Manager |
Expected Output
| Field Name | Example Values |
|---|---|
| Position ID | 331 |
| Position Name | Product Manager |
59. Search Schools
Search schools/universities by name to look up school IDs
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Search Term | String | Yes | School name search (min 3 chars) | Stanford |
Expected Output
| Field Name | Example Values |
|---|---|
| School ID | 1123 |
| Name | Stanford University |
60. Create School
Create a new school/university by name
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | String | Yes | School/university name | Springfield Community College |
Expected Output
| Field Name | Example Values |
|---|---|
| School ID | 4471 |
| Name | Springfield Community College |
61. Search Degrees
Search degrees by name to look up degree IDs
Possible Inputs
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
| Search Term | String | No | Degree name search | Bachelor |
| Ordering | String | No | rank or name | rank |
Expected Output
| Field Name | Example Values |
|---|---|
| Degree ID | 45 |
| Name | Bachelor of Science |
62. List Industries
List available industries
Possible Inputs
No input
Expected Output
| Field Name | Example Values |
|---|---|
| Industry ID | 3 |
| Name | Fintech |
63. List Currencies
List available currencies.
Possible Inputs
No parameters. Input: {}.
Expected Output
Returns a list of records.
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
id |
integer | No | Currency ID. Pass this as currency in update_job. |
1 |
name |
string or null | No | Currency name | "US Dollar" |
symbol |
string or null | No | Currency symbol | "$" |
code |
string or null | No | Currency code | "USD" |
64. List Client Users
List users available for ownership assignments.
Possible Inputs
No parameters. Input: {}.
Expected Output
Returns a list of records.
| Field Name | Type | Required | Description | Example |
|---|---|---|---|---|
id |
integer | No | User ID. Pass this as owner in update_job or update_organization. |
1 |
full_name |
string or null | No | Full name of the user | "John Smith" |
display_name |
string or null | No | Display name of the user | "J. Smith" |
Note
This feature uses AI to support your recruitment workflow. AI outputs are meant to guide, not replace, your judgment. Outputs may not always be fully accurate or complete, we recommend reviewing them as part of your process. All final recruitment decisions remain your sole responsibility.