{
"openapi": "3.0.0",
"info": {
"title": "Recruit CRM API",
"description": "# Status Codes\n\nRecruit CRM API uses conventional HTTP response codes to indicate the success or failure of an API request.\n\n| Verb | Description |\n|:-------|:------------------------------------------------------------------|\n|**GET** |Select one or more items. Success returns `200` status code |\n|**POST**|Create a new item. Success returns `200` or `201` status code |\n\n## HTTP status code summary\n\n\n|**Status Code** |**Description** |\n|:----------------------------|:------------------------------------------------------------------------------------------------------------------------------------|\n|**200 OK** |Everything worked as expected. |\n|**201 Created** |Your request has been processed successfully and the record has been created |\n|**202 Accepted** |Your request is currently being processed. You can check again later to see the request has been processed |\n|**400 Bad Request** |Your request was malformed |\n|**403 Forbidden** |Your API Token is invalid, missing, or has exceeded its quota |\n|**404 Not Found** |This resource cannot be found. You will receive this status code if you attempt to query our deprecated endpoints |\n|**405 Method Not Allowed** |You have queried the API with an unsupported HTTP method. Retry your query with either `GET` or `POST` |\n|**422 Invalid** |Invalid or missing API query parameter |\n|**429 Too Many Requests** |Too many requests issued to the API. Rate limiting kicks in and blocks further requests |\n|**500 Internal Server Error**|There was an unexpected error on our server. If you see this please contact [support@recruitcrm.io](mailto:support@recruitcrm.io) |\n\n## Error Types\n\n\n|Type |Description |\n|:--------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|**api\\_connection\\_error** |Failure to connect to Recruit CRM API. |\n|**api\\_error** |API errors cover any other type of problem (e.g., a temporary problem with Recruit CRM’s servers), and are extremely uncommon. |\n|**authentication\\_error** |Failure to authenticate your identity in the request |\n|**token_not_active\\_error**|API token is not active, you must activate your token to use API. |\n|**rate\\_limit\\_error** |Too many requests hit the API too quickly. |\n|**invalid\\_request\\_error**|Invalid request errors arise when your request has invalid parameters. |\n|**validation\\_error** |Errors triggered by our client-side libraries when failing to validate fields |\n|**Dates and Time** |All dates and time will be returned in the `ISO-8601 Date/Time Format` like `2020-06-29T05:36:22.000000Z`. Adjust accordingly in your application for the user's local timezone. |\n\nThe Recruit CRM API accepts `JSON` payloads making it very easy to work with, all posted fields must follow the correct format otherwise this will result in the API returning an error message. Please see the different options available to you below.\n\n**Note:** Whenever making API requests with GET method, please make sure that the query parameter values are URL encoded",
"contact": {
"email": "support@recruitcrm.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "8.6.9",
"x-logo": {
"url": "https://production-recruitcrm.s3-ap-southeast-1.amazonaws.com/api-assets/rcrm-logo.svg"
},
"x-tagGroups": [
{
"name": "Entities",
"tags": [
"Candidates",
"Contacts",
"Companies",
"Jobs",
"Deals",
"Tasks",
"Meetings",
"Notes",
"Call Logs",
"Hotlists",
"Custom Fields",
"Nested Custom Fields",
"Webhook Subscriptions",
"Sequences",
"Email"
]
}
]
},
"paths": {
"/v1/candidates/{candidate}/assign": {
"post": {
"tags": [
"Candidates"
],
"summary": "Assign Candidate",
"description": "Assign a candidate to a job.",
"operationId": "assignJob",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "job_slug",
"in": "query",
"description": "slug of the job",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "updated_by",
"in": "query",
"description": "ID of the user",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignedJob"
},
"examples": {
"Example": {
"value": {
"candidate_slug": "1278655",
"job_slug": "1206683",
"status": {
"status_id": 1,
"label": "Assigned"
},
"remark": "Updated",
"stage_date": "2020-03-25T16:14:28.000000Z",
"visibility": 1,
"shared_list_url": "https://recruitcrm.io/assigned_candidates/001",
"updated_on": "2020-03-25T16:14:28.000000Z",
"updated_by": 2354356
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/candidates/mark-off-limit": {
"post": {
"tags": [
"Candidates"
],
"summary": "Mark Candidate as Off Limit",
"description": "Mark Candidate as Off Limit with reason",
"operationId": "MarkAsOffLimit",
"requestBody": {
"description": "Mark AS OffLimit",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkOffLimitRequestForCandidate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkOffLimitResponseForCandidate"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/candidates/mark-as-available": {
"post": {
"tags": [
"Candidates"
],
"summary": "Mark Candidate as Available",
"description": "Mark Candidate as Available",
"operationId": "MarkAsAvailable",
"requestBody": {
"description": "Mark As Available",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkAvailableRequestForCandidate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkAvailableResponseForCandidate"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/candidates/off-limit": {
"get": {
"tags": [
"Candidates"
],
"summary": "Get List of candidates which are marked as off limit",
"description": "Get List of candidates which are marked as off limit",
"operationId": "GetOffLimitCandidates",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidatesNewFieldList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/candidates/{candidate}/off-limit-history": {
"get": {
"tags": [
"Candidates"
],
"summary": "Off Limit History for Candidate",
"description": "Returns the off-limit history for the requested candidate.\n\n**Note:** If the candidate was marked as off-limit in the past but is currently not off-limit, the latest status will be available along with the corresponding 'updated_on' timestamp.",
"operationId": "OffLimitHistoryForCandidate",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number for records",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OffLimitHistoryList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Record doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Record doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/{candidate}/unassign": {
"post": {
"tags": [
"Candidates"
],
"summary": "Un-assign Candidate",
"description": "Un-assign a candidate from the job.",
"operationId": "unassignJob",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "job_slug",
"in": "query",
"description": "slug of the job",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateNewFields"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/candidates/{candidate}/visibility/{job}": {
"post": {
"tags": [
"Candidates"
],
"summary": "Update Candidate Visibility in a Job",
"description": "Update a candidate's visibility in a job.",
"operationId": "updateVisibility",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "job",
"in": "path",
"description": "slug of the job",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "visibility",
"in": "query",
"description": "Visibility of candidate in a Job: For On - 1, Off - 0",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignedJob"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/candidates/{candidate}/history": {
"get": {
"tags": [
"Candidates"
],
"summary": "Candidate History",
"description": "Returns hiring stage history of the candidate",
"operationId": "getHistory",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/components/schemas/CandidateHistory"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/{candidate}/apply": {
"post": {
"tags": [
"Candidates"
],
"summary": "Apply to Job",
"description": "Apply to a job.",
"operationId": "applyJob",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "job_slug",
"in": "query",
"description": "slug of the job",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "updated_by",
"in": "query",
"description": "ID of the user",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppliedJob"
},
"examples": {
"example-1": {
"value": {
"candidate_slug": "1205129",
"job_slug": "1206683",
"status": {
"status_id": 1,
"label": "Applied"
},
"shared_list_url": "https://ss4web.recruitcrm.io/assigned_candidates/709831705571173",
"remark": "Updated",
"stage_date": "2020-03-25T16:14:28.000000Z",
"updated_by": 1234,
"updated_on": "2020-03-25T16:14:28.000000Z",
"visibility": 1
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/candidates": {
"get": {
"tags": [
"Candidates"
],
"summary": "Show all candidates",
"description": "Returns all candidates associated with your account.",
"operationId": "showAllCandidates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"schema": {
"type": "string",
"enum": [
"createdon",
"updatedon"
],
"default": "updatedon"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidatesNewFieldList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
},
"post": {
"tags": [
"Candidates"
],
"summary": "Creates a new candidate",
"description": "Creates a new Candidate.(Use Content-Type : Multipart/form-data if you want to upload any file)",
"operationId": "storeCandidate",
"requestBody": {
"description": "Candidate Object",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CandidateRequest"
},
"examples": {
"Example": {
"value": {
"first_name": "Michael",
"last_name": "Scott",
"email": "mscott@gmail.com",
"contact_number": "+1123226666",
"gender_id": 1,
"qualification_id": 4,
"specialization": "Computer Science",
"work_ex_year": 2,
"candidate_dob": "2000-06-29T05:36:22.000000Z",
"profile_updated_on": "2020-08-29T05:36:22.000000Z",
"current_salary": "150000",
"salary_expectation": "180000",
"willing_to_relocate": 1,
"current_organization": "",
"current_status": "Employed",
"notice_period": 60,
"currency_id": 2,
"facebook": "http://www.facebook.com/michael4",
"twitter": "http://www.twitter.com/michael4",
"linkedin": "http://www.linkedin.com/michael4",
"github": "",
"created_on": "2020-06-29T05:36:22.000000Z",
"updated_on": "2020-06-29T05:36:22.000000Z",
"city": "New York",
"locality": "Manhattan",
"state": "New York",
"country": "United States",
"address": "",
"relevant_experience": 2,
"position": "Software Developer",
"available_from": "2020-06-29T05:36:22.000000Z",
"salary_type": 1,
"source": "API",
"language_skills": [
{
"language_id": 38,
"proficiency_id": 3
}
],
"skill": "Python",
"custom_fields": [
{
"field_id": 1,
"value": "Custom Field"
},
{
"field_id": 2,
"value": "Custom Field"
}
],
"candidate_summary": "The primary candidate available is a highly skilled Java Developer with expertise in the C programming language. They have a strong command of the English language, possessing native or bilingual proficiency. Located in Slovenia, they are familiar with working in a Euro currency environment. With their extensive knowledge and experience, they are an ideal candidate for companies seeking a Java Developer who can contribute to their projects effectively."
}
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateNewFields"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateNewFields"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/candidates/{candidate}": {
"get": {
"tags": [
"Candidates"
],
"summary": "Find candidate by slug",
"description": "Returns a single candidate",
"operationId": "showCandidate",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateNewFields"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Candidates"
],
"summary": "Edit a candidate",
"description": "Edit a candidate.",
"operationId": "editCandidate",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate to edit",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Candidate Object",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CandidateRequest"
},
"examples": {
"Example": {
"value": {
"first_name": "Michael",
"last_name": "Scott",
"email": "mscott@gmail.com",
"contact_number": "+1123226666",
"gender_id": 1,
"qualification_id": 4,
"specialization": "Computer Science",
"work_ex_year": 2,
"candidate_dob": "2000-06-29T05:36:22.000000Z",
"profile_updated_on": "2020-08-29T05:36:22.000000Z",
"current_salary": "150000",
"salary_expectation": "180000",
"willing_to_relocate": 1,
"current_organization": "",
"current_status": "Employed",
"notice_period": 60,
"currency_id": 2,
"facebook": "http://www.facebook.com/michael4",
"twitter": "http://www.twitter.com/michael4",
"linkedin": "http://www.linkedin.com/michael4",
"github": "",
"created_on": "2020-06-29T05:36:22.000000Z",
"updated_on": "2020-06-29T05:36:22.000000Z",
"city": "New York",
"locality": "Manhattan",
"state": "New York",
"country": "United States",
"address": "",
"relevant_experience": 2,
"position": "Software Developer",
"available_from": "2020-06-29T05:36:22.000000Z",
"salary_type": 1,
"source": "API",
"language_skills": [
{
"language_id": 38,
"proficiency_id": 3
}
],
"skill": "Java,Python",
"resume": "string",
"custom_fields": [
{
"field_id": 1,
"value": "Region 1"
}
],
"candidate_summary": "The primary candidate available is a highly skilled Java Developer with expertise in the C programming language. They have a strong command of the English language, possessing native or bilingual proficiency. Located in Slovenia, they are familiar with working in a Euro currency environment. With their extensive knowledge and experience, they are an ideal candidate for companies seeking a Java Developer who can contribute to their projects effectively."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateNewFields"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Candidates"
],
"summary": "Delete a candidate",
"description": "Delete a candidate.",
"operationId": "deleteCandidate",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"parameters": [
{
"schema": {
"type": "integer"
},
"name": "candidate",
"in": "path",
"required": true
}
]
},
"/v1/candidates/search": {
"get": {
"tags": [
"Candidates"
],
"summary": "Search for candidates",
"description": "Returns all candidates associated with your account that matched the search.(Enter at least one additional parameter apart from 'sort_by' and 'sort_order' to get the search result.)",
"operationId": "searchCandidates",
"parameters": [
{
"name": "first_name",
"in": "query",
"description": "First Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last_name",
"in": "query",
"description": "Last Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"in": "query",
"description": "Email",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "linkedin",
"in": "query",
"description": "Linked In URL",
"required": false,
"schema": {
"type": "string"
}
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "contact_number",
"description": "Contact Number"
},
{
"name": "state",
"in": "query",
"description": "State",
"required": false,
"schema": {
"type": "string"
}
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "country",
"description": "Country"
},
{
"name": "created_from",
"in": "query",
"description": "Created (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "created_to",
"in": "query",
"description": "Created (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_from",
"in": "query",
"description": "Updated (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_to",
"in": "query",
"description": "Updated (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"schema": {
"type": "string",
"enum": [
"createdon",
"updatedon"
],
"default": "updatedon"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "candidate_slug",
"description": "Candidate Slug (If this filter is applied then other filters will be ignored)"
},
{
"name": "owner_id",
"in": "query",
"description": "Owner Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_name",
"in": "query",
"description": "Owner Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_email",
"in": "query",
"description": "Owner Email",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "marked_as_off_limit",
"in": "query",
"description": "Filter records based on off-limit status. Use 'true' to return only off-limit records, or 'false' to return records that are not marked as off-limit.",
"required": false,
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
},
{
"schema": {
"type": "string",
"enum": [
"true",
"false",
"1",
"0"
]
},
"in": "query",
"name": "exact_search",
"description": "If value of exact_search is true/1 then exact search will be performed else like search will be performed"
}
],
"requestBody": {
"description": "#### Search By custom Fields\nClick [here](https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjEyMzU5OTgw-custom-field) to know more about ``Supported Filter Types``",
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldSearch"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidatesNewFieldList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/candidates/{candidate}/hiring-stages": {
"get": {
"tags": [
"Candidates"
],
"summary": "Hiring Stages of Candidate",
"description": "Returns a list of hiring stages of a candidate.",
"operationId": "hiringStages",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateHiringStageList"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/{candidate}/hiring-stages/{job}": {
"get": {
"tags": [
"Candidates"
],
"summary": "Hiring Stage of Candidate for Job",
"description": "Returns the hiring stage of a candidate for a particular job.",
"operationId": "hiringStage",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "job",
"in": "path",
"description": "slug of the job",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateAssignedJob"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Candidates"
],
"summary": "Update Candidate Hiring Stage",
"description": "Update a candidate's hiring stage.",
"operationId": "updateHiringStage",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "job",
"in": "path",
"description": "slug of the job",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateHiringStage"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignedJob"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/candidates/{candidate}/request-update": {
"get": {
"tags": [
"Candidates"
],
"summary": "Request Updated Profile",
"description": "Returns the url to request an updated profile of the candidate",
"operationId": "requestUpdatedProfile",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"properties": {
"url": {
"type": "string",
"example": "http://recruitcrm.io/update_resume_link/rcrm_25627"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/profile-update-request-form": {
"get": {
"tags": [
"Candidates"
],
"summary": "Get Profile Update Request Form",
"description": "Returns the profile update request form",
"operationId": "getProfileUpdateRequestForm",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "success"
},
"data": {
"type": "object",
"properties": {
"profile_update_setting_form_data": {
"type": "object",
"properties": {
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "Personal Information"
},
"subtitle": {
"type": "string",
"example": "Please fill in your personal details"
},
"position": {
"type": "integer",
"example": 1
},
"required": {
"type": "boolean",
"example": true
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldId": {
"type": [
"integer",
"null"
],
"example": 1
},
"fieldName": {
"type": "string",
"example": "first_name"
},
"fieldLabel": {
"type": "string",
"example": "First Name"
},
"fieldType": {
"type": [
"string",
"null"
],
"example": "text"
},
"placeholder": {
"type": "string",
"example": "John"
},
"required": {
"type": "boolean",
"example": true
},
"position": {
"type": "integer",
"example": 1
},
"defaultValue": {
"type": [
"string",
"null"
],
"example": null
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Profile Update Form Fields Setting is Empty",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "integer",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Profile Update Form Fields Setting is Empty"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/work-history/create": {
"post": {
"tags": [
"Candidates"
],
"summary": "Add Work Experience",
"description": "Add a Work Experience for Candidate.",
"operationId": "storeCandidateWorkExperience",
"requestBody": {
"description": "Candidate Work Experience Array of Object \n\n**Note: This endpoint has request limit of 50 records per call. \n Also, a candidate can only have 10 Work History.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkHistoryRequest"
},
"examples": {
"Example": {
"$ref": "#/components/examples/WorkHistoryExample"
}
}
}
}
},
"responses": {
"200": {
"description": "Work History added successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"statusCode": {
"description": "Status Code",
"type": "string",
"example": "200"
},
"message": {
"description": "Success Message",
"type": "string",
"example": "Work History added successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
},
"429": {
"description": "Request limit exceeded! Maximum 50 records can be added at once OR Maximum 10 history can be added for a candidate",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "429"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Request limit exceeded! Maximum 50 records can be added at once OR Maximum 10 history can be added for a candidate"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/work-history/{workId}": {
"post": {
"tags": [
"Candidates"
],
"summary": "Edit Work Experience",
"description": "Update a Candidate Work Experience.",
"operationId": "updateCandidateWorkExperience",
"parameters": [
{
"name": "workId",
"in": "path",
"description": "ID of the work experience",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Candidate Work Experience Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkHistoryEditRequest"
},
"examples": {
"Example": {
"$ref": "#/components/examples/WorkHistoryEditExample"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkHistoryResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Candidates"
],
"summary": "Delete a candidate work experience",
"description": "Delete a Candidate Work Experience.",
"operationId": "deleteCandidateWorkExperience",
"parameters": [
{
"name": "workId",
"in": "path",
"description": "ID of the work experience",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Work experience deleted successfully.",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"statusCode": {
"description": "Status Code",
"type": "string",
"example": "200"
},
"message": {
"description": "Success Message",
"type": "string",
"example": "Work experience deleted successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Work experience doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Work experience doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/{candidate}/work-history": {
"get": {
"tags": [
"Candidates"
],
"summary": "Candidate Work Experience",
"description": "Get a list of Candidate Work Experience.",
"operationId": "getCandidateWorkExperience",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Array of objects for Candidate work history",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkHistoryResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/education-history/create": {
"post": {
"tags": [
"Candidates"
],
"summary": "Add Education History",
"description": "Add a Education History for Candidate.",
"operationId": "storeCandidateEducationHistory",
"requestBody": {
"description": "Candidate Education History Array of Object\n\n**Note: This endpoint has request limit of 50 records per call.\nAlso, a candidate can only have 10 Education History.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EducationHistoryRequest"
},
"examples": {
"Example": {
"$ref": "#/components/examples/EducationHistoryExample"
}
}
}
}
},
"responses": {
"200": {
"description": "Education History added successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"statusCode": {
"description": "Status Code",
"type": "string",
"example": "200"
},
"message": {
"description": "Success Message",
"type": "string",
"example": "Education History added successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
},
"429": {
"description": "Request limit exceeded! Maximum 50 records can be added at once OR Maximum 10 history can be added for a candidate",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "429"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Request limit exceeded! Maximum 50 records can be added at once OR Maximum 10 history can be added for a candidate"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/education-history/{educationId}": {
"post": {
"tags": [
"Candidates"
],
"summary": "Edit Education History",
"description": "Update a Candidate Education History.",
"operationId": "updateCandidateEducationHistory",
"parameters": [
{
"name": "educationId",
"in": "path",
"description": "ID of the education history",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Candidate Education History Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EducationHistoryEditRequest"
},
"examples": {
"Example": {
"$ref": "#/components/examples/EducationHistoryEditExample"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EducationHistoryResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Candidates"
],
"summary": "Delete a candidate Education History",
"description": "Delete a Candidate Education History.",
"operationId": "deleteCandidateEducationHistory",
"parameters": [
{
"name": "educationId",
"in": "path",
"description": "ID of the education history",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Education history deleted successfully.",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"statusCode": {
"description": "Status Code",
"type": "string",
"example": "200"
},
"message": {
"description": "Success Message",
"type": "string",
"example": "Education history deleted successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Education history doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Education history doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/{candidate}/education-history": {
"get": {
"tags": [
"Candidates"
],
"summary": "Candidate Education History",
"description": "Get a list of Candidate Education History.",
"operationId": "getCandidateEducationHistory",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Array of objects for Candidate education history",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EducationHistoryResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/question-and-answers/{candidate}": {
"get": {
"tags": [
"Candidates"
],
"summary": "Question And Answers of Candidate",
"description": "Returns a list of all the answered questions which are not related to any job.",
"operationId": "CandidateQuestionAnswer",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unanswered",
"in": "query",
"description": "To get the unanswered questions. Use the value 1 for true, and 0 for false.",
"required": false,
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"statusCode": {
"description": "Success Code",
"type": "number",
"example": 200
},
"message": {
"description": "Success Message",
"type": "string",
"example": "Fetched Question and Answer successfully"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CandidateQuestionsAndAnswers"
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"statusCode": {
"description": "Error Code",
"type": "number",
"example": 404
},
"message": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Candidates"
],
"summary": "Update Candidate Answers for the Questions",
"description": "Update a candidate's answer for a question.",
"operationId": "updateCandidateQuestionAnswer",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Array of objects for Candidate Question and Answer",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateQuestionsAndAnswersRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"statusCode": {
"description": "Success Code",
"type": "number",
"example": 200
},
"message": {
"description": "Success Message",
"type": "string",
"example": "Answer updated successfully"
},
"data": {
"type": "array",
"items": {
"properties": {
"answer_id": {
"description": "Answer ID",
"type": "number",
"example": 1
},
"answer": {
"description": "Answer",
"type": "string",
"example": "I'm from India."
},
"question_id": {
"description": "Question ID",
"type": "number",
"example": 1
},
"question": {
"description": "Question",
"type": "string",
"example": "Where are you from?"
}
}
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"statusCode": {
"description": "Error Code",
"type": "number",
"example": 404
},
"message": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/question-and-answers/{candidate}/{job}": {
"get": {
"tags": [
"Candidates"
],
"summary": "Question And Answers of Candidate for Job",
"description": "Returns a list of all the answered questions which are related to the given job.",
"operationId": "getCandidateQuestionAnswer",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "job",
"in": "path",
"description": "slug of the job",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unanswered",
"in": "query",
"description": "To get the unanswered questions. Use the value 1 for true, and 0 for false.",
"required": false,
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"statusCode": {
"description": "Success Code",
"type": "number",
"example": 200
},
"message": {
"description": "Success Message",
"type": "string",
"example": "Fetched Question and Answer successfully"
},
"job_id": {
"description": "Job ID",
"type": "number",
"example": 1
},
"job_name": {
"description": "Job Name",
"type": "string",
"example": "Full Stack Developer"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CandidateJobQuestionsAndAnswers"
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"statusCode": {
"description": "Error Code",
"type": "number",
"example": 404
},
"message": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Candidates"
],
"summary": "Update Candidate Answers for the Questions for a Job",
"description": "Update a candidate's answer for a question related to a job.",
"operationId": "updateCandidateJobQuestionAnswer",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "Slug of the candidate",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "job",
"in": "path",
"description": "Slug of the job",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Array of objects for Candidate Question and Answer",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateQuestionsAndAnswersRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"successCode": {
"description": "Success Code",
"type": "number",
"example": 200
},
"message": {
"description": "Success Message",
"type": "string",
"example": "Answer updated successfully"
},
"job_id": {
"description": "Job ID",
"type": "number",
"example": 1
},
"job_name": {
"description": "Job Name",
"type": "string",
"example": "Full Stack Developer"
},
"data": {
"type": "array",
"items": {
"properties": {
"answer_id": {
"description": "Answer ID",
"type": "number",
"example": 1
},
"answer": {
"description": "Answer",
"type": "string",
"example": "I'm from India."
},
"question_id": {
"description": "Question ID",
"type": "number",
"example": 1
},
"question": {
"description": "Question",
"type": "string",
"example": "Where are you from?"
}
}
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"statusCode": {
"description": "Error Code",
"type": "number",
"example": 404
},
"message": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/candidates/{candidate}/enroll": {
"post": {
"tags": [
"Sequences"
],
"summary": "Enroll Candidate",
"description": "Enroll a candidate in a Sequence.",
"operationId": "enrollCandidate",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "Slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sequence_id",
"in": "query",
"description": "ID of the sequence",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "enrolled_by",
"in": "query",
"description": "ID of the user",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnrollCandidate"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/candidates/{candidate}/un-enroll": {
"post": {
"tags": [
"Sequences"
],
"summary": "Unenroll Candidate",
"description": "Unenroll a candidate from a Sequence.",
"operationId": "UnenrollCandidate",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "Slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unenrolled_by",
"in": "query",
"description": "ID of the user",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnrollCandidate"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/candidates/associated-field/{candidate}/{job}": {
"get": {
"tags": [
"Candidates"
],
"summary": "Get Job Associated Fields",
"description": "Returns a list of all the values of job associated fields for a job.",
"operationId": "getJobAssociatedFields",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "job",
"in": "path",
"description": "slug of the job",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"statusCode": {
"description": "Success Code",
"type": "number",
"example": 200
},
"message": {
"description": "Success Message",
"type": "string",
"example": "Job Associated Fields for the job: 'Job Name' for this candidate: 'Candidate Name'"
},
"data": {
"type": "array",
"items": {
"properties": {
"0": {
"type": "object",
"properties": {
"columnid": {
"description": "Column ID",
"type": "number",
"example": 1
},
"label": {
"description": "Label",
"type": "string",
"example": "Job Associated Field"
},
"value": {
"description": "Value",
"type": "string",
"example": "Value of the field"
}
}
}
}
}
}
}
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"statusCode": {
"description": "Error Code",
"type": "number",
"example": 404
},
"message": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Candidates"
],
"summary": "Update Job Associated Fields",
"description": "Update the values of job associated fields for a job.",
"operationId": "updateJobAssociatedCustomFields",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "job",
"in": "path",
"description": "slug of the job",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Array of job associated fields",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobAssociatedFields"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"statusCode": {
"description": "Success Code",
"type": "number",
"example": 200
},
"message": {
"description": "Success Message",
"type": "string",
"example": "Associated Custom fields Updated Successfully"
},
"data": {
"type": "array",
"items": {
"properties": {
"0": {
"type": "object",
"properties": {
"field_id": {
"description": "Field ID",
"type": "number",
"example": 1
},
"value": {
"description": "Value",
"type": "string",
"example": "Value of the field"
}
}
}
}
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"statusCode": {
"description": "Error Code",
"type": "number",
"example": 404
},
"message": {
"description": "Error Message",
"type": "string",
"example": "Candidate doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/companies": {
"get": {
"tags": [
"Companies"
],
"summary": "Show all companies",
"description": "Returns all companies associated with your account.",
"operationId": "showAllCompanies",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"schema": {
"type": "string",
"enum": [
"createdon",
"updatedon"
],
"default": "updatedon"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompaniesList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
},
"post": {
"tags": [
"Companies"
],
"summary": "Creates a new company",
"description": "Creates a new company.",
"operationId": "storeCompany",
"requestBody": {
"description": "Company Object",
"required": true,
"content": {
"application/json": {
"schema": {
"description": "",
"type": "object",
"properties": {
"company_name": {
"type": "string",
"minLength": 1
},
"about_company": {
"type": "string",
"maxLength": 5000
},
"city": {
"type": "string",
"minLength": 1
},
"locality": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"minLength": 1
},
"country": {
"type": "string",
"minLength": 1
},
"postal_code": {
"type": "string",
"minLength": 1
},
"address": {
"type": "string"
},
"industry_id": {
"type": "number"
},
"logo": {
"type": "string"
},
"website": {
"type": "string",
"minLength": 1
},
"facebook": {
"type": "string",
"minLength": 1
},
"twitter": {
"type": "string"
},
"linkedin": {
"type": "string"
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"custom_fields": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"field_id": {
"type": "number"
},
"value": {
"type": "string",
"minLength": 1
}
}
}
}
},
"required": [
"company_name"
]
},
"examples": {
"Example": {
"value": {
"company_name": "Acme Inc",
"city": "New York",
"address": "",
"industry_id": 1,
"logo": "",
"website": "https://www.example.com",
"facebook": "https://facebook.com/acme",
"twitter": "",
"linkedin": "",
"custom_fields": [
{
"field_id": 1,
"value": "ACME-929"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Company"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/companies/mark-off-limit": {
"post": {
"tags": [
"Companies"
],
"summary": "Mark Companies as Off Limit",
"description": "Mark Companies as Off Limit with reason",
"operationId": "MarkAsOffLimit",
"requestBody": {
"description": "Mark AS OffLimit",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkOffLimitRequestForCompanies"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkOffLimitResponseForCompanies"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/companies/mark-as-available": {
"post": {
"tags": [
"Companies"
],
"summary": "Mark Companies as Available",
"description": "Mark Companies as Available",
"operationId": "MarkAsAvailable",
"requestBody": {
"description": "Mark AS Available",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkAvailableRequestForCompany"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkAvailableResponseForCompany"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/companies/off-limit": {
"get": {
"tags": [
"Companies"
],
"summary": "Get List of Companies which are marked as off limit",
"description": "Get List of Companies which are marked as off limit",
"operationId": "GetOffLimitCompanies",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Company"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/companies/{company}/off-limit-history": {
"get": {
"tags": [
"companies"
],
"summary": "Off Limit History for Company",
"description": "Returns the off-limit history for the requested company.\n\n**Note:** If the company was marked as off-limit in the past but is currently not off-limit, the latest status will be available along with the corresponding 'updated_on' timestamp.",
"operationId": "OffLimitHistoryForCompany",
"parameters": [
{
"name": "company",
"in": "path",
"description": "slug of the company",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number for records",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OffLimitHistoryList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Record doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Record doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/companies/{company}": {
"get": {
"tags": [
"Companies"
],
"summary": "Find company by slug",
"description": "Returns a single company",
"operationId": "showCompany",
"parameters": [
{
"name": "company",
"in": "path",
"description": "slug of the company to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Company"
}
}
}
},
"404": {
"description": "Company doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Company doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Companies"
],
"summary": "Edit a company",
"description": "Edit a company.",
"operationId": "editCompany",
"parameters": [
{
"name": "company",
"in": "path",
"description": "slug of the company to edit",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Company Object",
"required": true,
"content": {
"application/json": {
"schema": {
"description": "",
"type": "object",
"properties": {
"company_name": {
"type": "string",
"minLength": 1
},
"about_company": {
"type": "string",
"maxLength": 5000
},
"city": {
"type": "string",
"minLength": 1
},
"locality": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"minLength": 1
},
"country": {
"type": "string",
"minLength": 1
},
"postal_code": {
"type": "string",
"minLength": 1
},
"address": {
"type": "string"
},
"industry_id": {
"type": "number"
},
"logo": {
"type": "string"
},
"website": {
"type": "string",
"minLength": 1
},
"facebook": {
"type": "string",
"minLength": 1
},
"twitter": {
"type": "string"
},
"linkedin": {
"type": "string"
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"custom_fields": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"field_id": {
"type": "number"
},
"value": {
"type": "string",
"minLength": 1
}
}
}
}
},
"required": [
"company_name"
]
},
"examples": {
"Example": {
"value": {
"company_name": "Acme Inc",
"city": "New York",
"address": "",
"industry_id": 1,
"logo": "",
"website": "https://www.example.com",
"facebook": "https://facebook.com/acme",
"twitter": "",
"linkedin": "",
"custom_fields": [
{
"field_id": 1,
"value": "ACME-929"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Company"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Companies"
],
"summary": "Delete a company",
"description": "Delete a company.",
"operationId": "deleteCompany",
"parameters": [
{
"name": "company",
"in": "path",
"description": "slug of the company to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Company doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Company doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/companies/search": {
"get": {
"tags": [
"Companies"
],
"summary": "Search for companies",
"description": "Returns all companies associated with your account that matched the search.(Enter at least one additional parameter apart from 'sort_by' and 'sort_order' to get the search result.)",
"operationId": "searchCompanies",
"parameters": [
{
"name": "company_name",
"in": "query",
"description": "Company Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "created_from",
"in": "query",
"description": "Created (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "created_to",
"in": "query",
"description": "Created (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_from",
"in": "query",
"description": "Updated (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_to",
"in": "query",
"description": "Updated (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"schema": {
"type": "string",
"enum": [
"createdon",
"updatedon"
],
"default": "updatedon"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "company_slug",
"description": "Company Slug (If this filter is applied then other filters will be ignored)"
},
{
"name": "owner_id",
"in": "query",
"description": "Owner Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_name",
"in": "query",
"description": "Owner Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_email",
"in": "query",
"description": "Owner Email",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "marked_as_off_limit",
"in": "query",
"description": "Filter records based on off-limit status. Use 'true' to return only off-limit records, or 'false' to return records that are not marked as off-limit.",
"required": false,
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
},
{
"schema": {
"type": "string",
"enum": [
"true",
"false",
"1",
"0"
]
},
"in": "query",
"name": "exact_search",
"description": "If value of exact_search is true/1 then exact search will be performed else like search will be performed"
}
],
"requestBody": {
"description": "#### Search By custom Fields\nClick [here](https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjEyMzU5OTgw-custom-field) to know more about ``Supported Filter Types``",
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldSearch"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompaniesList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/contacts": {
"get": {
"tags": [
"Contacts"
],
"summary": "Show all contacts",
"description": "Returns all contacts associated with your account.",
"operationId": "showAllContacts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"schema": {
"type": "string",
"enum": [
"createdon",
"updatedon"
],
"default": "updatedon"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactsNewFieldList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
},
"post": {
"tags": [
"Contacts"
],
"summary": "Creates a new contact",
"description": "Creates a new contact.",
"operationId": "storeContact",
"requestBody": {
"description": "Contact Object",
"required": true,
"content": {
"application/json": {
"schema": {
"description": "",
"type": "object",
"properties": {
"first_name": {
"type": "string",
"minLength": 1
},
"last_name": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"minLength": 1
},
"contact_number": {
"type": "string",
"minLength": 1
},
"company_slug": {
"type": "string",
"description": "Comma separated company slugs"
},
"avatar": {
"type": "string"
},
"city": {
"type": "string",
"minLength": 1
},
"locality": {
"type": "string"
},
"state": {
"type": "string",
"minLength": 1
},
"country": {
"type": "string",
"minLength": 1
},
"postal_code": {
"type": "string",
"minLength": 1
},
"address": {
"type": "string"
},
"designation": {
"type": "string",
"description": "Designation of the contact | This is title field",
"minLength": 1
},
"facebook": {
"type": "string",
"minLength": 1
},
"twitter": {
"type": "string"
},
"linkedin": {
"type": "string"
},
"stage_id": {
"type": "number"
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"custom_fields": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"field_id": {
"type": "number"
},
"value": {
"type": "string",
"minLength": 1
}
}
}
}
},
"required": [
"first_name",
"last_name"
]
},
"examples": {
"Example": {
"$ref": "#/components/examples/Contact"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactWithNewFields"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/contacts/mark-off-limit": {
"post": {
"tags": [
"Contacts"
],
"summary": "Mark Contacts as Off Limit",
"description": "Mark Contacts as Off Limit with reason",
"operationId": "MarkAsOffLimit",
"requestBody": {
"description": "Mark AS OffLimit",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkOffLimitRequestForContact"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkOffLimitResponseForContact"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/contacts/mark-as-available": {
"post": {
"tags": [
"Contacts"
],
"summary": "Mark Contacts as Available",
"description": "Mark Contacts as Available",
"operationId": "MarkAsAvailable",
"requestBody": {
"description": "Mark As Available",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkAvailableRequestForContact"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkAvailableResponseForContact"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/contacts/off-limit": {
"get": {
"tags": [
"Contacts"
],
"summary": "Get List of Contacts which are marked as off limit",
"description": "Get List of Contacts which are marked as off limit",
"operationId": "GetOffLimitContacts",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactsNewFieldList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/contacts/{contact}/off-limit-history": {
"get": {
"tags": [
"Contacts"
],
"summary": "Off Limit History for Contact",
"description": "Returns the off-limit history for the requested contact.\n\n**Note:** If the contact was marked as off-limit in the past but is currently not off-limit, the latest status will be available along with the corresponding 'updated_on' timestamp.",
"operationId": "OffLimitHistoryForContact",
"parameters": [
{
"name": "contact",
"in": "path",
"description": "slug of the contact",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number for records",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OffLimitHistoryList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Record doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Record doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/contacts/{contact}": {
"get": {
"tags": [
"Contacts"
],
"summary": "Find contact by slug",
"description": "Returns a single contact",
"operationId": "showContact",
"parameters": [
{
"name": "contact",
"in": "path",
"description": "slug of the contact to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactWithNewFields"
}
}
}
},
"404": {
"description": "Contact doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Contact doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Contacts"
],
"summary": "Edit a contact",
"description": "Edit a contact.",
"operationId": "editContact",
"parameters": [
{
"name": "contact",
"in": "path",
"description": "slug of the contact to edit",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Contact Object",
"required": true,
"content": {
"application/json": {
"schema": {
"description": "",
"type": "object",
"properties": {
"first_name": {
"type": "string",
"minLength": 1
},
"last_name": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"minLength": 1
},
"contact_number": {
"type": "string",
"minLength": 1
},
"company_slug": {
"type": "string",
"description": "Comma separated company slugs"
},
"avatar": {
"type": "string"
},
"city": {
"type": "string",
"minLength": 1
},
"locality": {
"type": "string"
},
"state": {
"type": "string",
"minLength": 1
},
"country": {
"type": "string",
"minLength": 1
},
"postal_code": {
"type": "string",
"minLength": 1
},
"address": {
"type": "string"
},
"designation": {
"type": "string",
"description": "Designation of the contact | This is title field",
"minLength": 1
},
"facebook": {
"type": "string",
"minLength": 1
},
"twitter": {
"type": "string"
},
"linkedin": {
"type": "string"
},
"stage_id": {
"type": "number"
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"custom_fields": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"field_id": {
"type": "number"
},
"value": {
"type": "string",
"minLength": 1
}
}
}
}
}
},
"examples": {
"Example": {
"$ref": "#/components/examples/Contact"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactWithNewFields"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Contacts"
],
"summary": "Delete a contact",
"description": "Delete a contact.",
"operationId": "deleteContact",
"parameters": [
{
"name": "contact",
"in": "path",
"description": "slug of the contact to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Contact doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Contact doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/contacts/search": {
"get": {
"tags": [
"Contacts"
],
"summary": "Search for contacts",
"description": "Returns all contacts associated with your account that matched the search.(Enter at least one additional parameter apart from 'sort_by' and 'sort_order' to get the search result.)",
"operationId": "searchContacts",
"parameters": [
{
"name": "first_name",
"in": "query",
"description": "First Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last_name",
"in": "query",
"description": "Last Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"in": "query",
"description": "Email",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "linkedin",
"in": "query",
"description": "Linked In URL",
"required": false,
"schema": {
"type": "string"
}
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "contact_number",
"description": "Contact Number"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "company_slug",
"description": "Company Slug"
},
{
"name": "created_from",
"in": "query",
"description": "Created (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "created_to",
"in": "query",
"description": "Created (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_from",
"in": "query",
"description": "Updated (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_to",
"in": "query",
"description": "Updated (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"schema": {
"type": "string",
"enum": [
"createdon",
"updatedon"
],
"default": "updatedon"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "contact_slug",
"description": "Contact Slug (If this filter is applied then other filters will be ignored)"
},
{
"name": "owner_id",
"in": "query",
"description": "Owner Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_name",
"in": "query",
"description": "Owner Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_email",
"in": "query",
"description": "Owner Email",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "marked_as_off_limit",
"in": "query",
"description": "Filter records based on off-limit status. Use 'true' to return only off-limit records, or 'false' to return records that are not marked as off-limit.",
"required": false,
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
},
{
"schema": {
"type": "string",
"enum": [
"true",
"false",
"1",
"0"
]
},
"in": "query",
"name": "exact_search",
"description": "If value of exact_search is true/1 then exact search will be performed else like search will be performed"
}
],
"requestBody": {
"description": "#### Search By custom Fields\nClick [here](https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjEyMzU5OTgw-custom-field) to know more about ``Supported Filter Types``",
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldSearch"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactsNewFieldList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/contacts/{contact}/enroll": {
"post": {
"tags": [
"Sequences"
],
"summary": "Enroll Contact",
"description": "Enroll a contact in a sequence.",
"operationId": "EnrollContact",
"parameters": [
{
"name": "contact",
"in": "path",
"description": "Slug of the contact",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sequence_id",
"in": "query",
"description": "ID of the sequence",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "enrolled_by",
"in": "query",
"description": "ID of the user",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnrollContact"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/contacts/{contact}/un-enroll": {
"post": {
"tags": [
"Sequences"
],
"summary": "Unenroll Contact",
"description": "Unenroll a contact from a Sequence.",
"operationId": "UnenrollContact",
"parameters": [
{
"name": "contact",
"in": "path",
"description": "Slug of the contact",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unenrolled_by",
"in": "query",
"description": "ID of the user",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnrollContact"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/deals": {
"get": {
"summary": "Show all Deals",
"description": "Returns all deals associated with your account.",
"operationId": "showAllDeals",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"schema": {
"type": "string",
"enum": [
"createdon",
"updatedon"
],
"default": "updatedon"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
},
{
"name": "archived",
"in": "query",
"description": "Get records based on archived status. Use '1' to return only archived records, or '0' to return records that are not archived.",
"required": false,
"schema": {
"type": "string",
"enum": [
"1",
"0"
]
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
},
"tags": [
"Deals"
]
},
"post": {
"summary": "Creates a new Deal",
"description": "Creates a new Deal.",
"operationId": "storeDeal",
"parameters": [
{
"name": "expand",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example": "*,null,company,contacts,candidate,job,deal_split,created_by,updated_by,owner"
}
],
"requestBody": {
"description": "Deal Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealRequest"
},
"examples": {
"Example": {
"$ref": "#/components/examples/Deal"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Deal"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
},
"tags": [
"Deals"
]
}
},
"/v1/deals/{deal}": {
"get": {
"tags": [
"Deals"
],
"summary": "Find deal by slug",
"description": "Returns a single deal",
"operationId": "showDeal",
"parameters": [
{
"name": "deal",
"in": "path",
"description": "slug of the deal to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Deal"
}
}
}
},
"404": {
"description": "Deal doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Deal doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Deals"
],
"summary": "Edit a deal",
"description": "Edit a deal.",
"operationId": "editDeal",
"parameters": [
{
"name": "deal",
"in": "path",
"description": "slug of the deal to edit",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expand",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example": "*,null,company,contacts,candidate,job,deal_split,created_by,updated_by,owner"
}
],
"requestBody": {
"description": "Deal Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealRequest"
},
"examples": {
"Example": {
"$ref": "#/components/examples/Deal"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Deal"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Deals"
],
"summary": "Delete a deal",
"description": "Delete a deal.",
"operationId": "deleteDeal",
"parameters": [
{
"name": "deal",
"in": "path",
"description": "slug of the deal to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Deal doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Deal doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/deals/search": {
"get": {
"tags": [
"Deals"
],
"summary": "Search for deals",
"description": "Returns all deals associated with your account that matched the search.(Enter at least one additional parameter apart from sort_by and sort_order to get the search result.)",
"operationId": "searchDeals",
"parameters": [
{
"name": "deal_name",
"in": "query",
"description": "Deal Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "deal_stage",
"in": "query",
"description": "stage",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "company_name",
"in": "query",
"description": "Company Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "company_slug",
"in": "query",
"description": "Company Slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contact_name",
"in": "query",
"description": "Contact Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contact_slug",
"in": "query",
"description": "Contact Slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "candidate_name",
"in": "query",
"description": "Candidate Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "candidate_slug",
"in": "query",
"description": "Candidate Slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "job_name",
"in": "query",
"description": "Job Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "job_slug",
"in": "query",
"description": "Job Slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_name",
"in": "query",
"description": "Owner Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "closing_from",
"in": "query",
"description": "Closing (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "closing_to",
"in": "query",
"description": "Closing (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "added_from",
"in": "query",
"description": "Added (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "added_to",
"in": "query",
"description": "Added (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_from",
"in": "query",
"description": "Updated (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_to",
"in": "query",
"description": "Updated (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"schema": {
"type": "string",
"enum": [
"createdon",
"updatedon"
],
"default": "updatedon"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "deal_slug",
"description": "Deal Slug (If this filter is applied then other filters will be ignored)"
},
{
"name": "owner_id",
"in": "query",
"description": "Owner Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_email",
"in": "query",
"description": "Owner Email",
"required": false,
"schema": {
"type": "string"
}
},
{
"schema": {
"type": "string",
"enum": [
"true",
"false",
"1",
"0"
]
},
"in": "query",
"name": "exact_search",
"description": "If value of exact_search is true/1 then exact search will be performed else like search will be performed"
},
{
"name": "archived",
"in": "query",
"description": "Filter records based on archived status. Use '1' to return only archived records, or '0' to return records that are not archived.",
"required": false,
"schema": {
"type": "string",
"enum": [
"1",
"0"
]
}
}
],
"requestBody": {
"description": "#### Search By custom Fields\nClick [here](https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjEyMzU5OTgw-custom-field) to know more about ``Supported Filter Types``",
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldSearch"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/hotlists": {
"get": {
"tags": [
"Hotlists"
],
"summary": "Show all Hotlists",
"description": "Returns all hotlists associated with your account.",
"operationId": "showAllHotlists",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HotlistsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
},
"post": {
"tags": [
"Hotlists"
],
"summary": "Creates a new Hotlist",
"description": "Creates a new Hotlist.",
"operationId": "storeHotlist",
"requestBody": {
"description": "Hotlist Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HotlistRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Hotlist"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/hotlists/{hotlist}": {
"get": {
"tags": [
"Hotlists"
],
"summary": "Find hotlist by ID",
"description": "Returns a single hotlist",
"operationId": "showHotlist",
"parameters": [
{
"name": "hotlist",
"in": "path",
"description": "ID of the hotlist to return",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Hotlist"
}
}
}
},
"404": {
"description": "Hotlist doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Hotlist doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Hotlists"
],
"summary": "Edit a hotlist",
"description": "Edit a hotlist.",
"operationId": "editHotlist",
"parameters": [
{
"name": "hotlist",
"in": "path",
"description": "ID of the hotlist to edit",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Hotlist Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HotlistRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Hotlist"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Hotlists"
],
"summary": "Delete a hotlist",
"description": "Delete a hotlist.",
"operationId": "deleteHotlist",
"parameters": [
{
"name": "hotlist",
"in": "path",
"description": "ID of the hotlist to delete",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Hotlist doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Hotlist doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/hotlists/{hotlist}/add-record": {
"post": {
"tags": [
"Hotlists"
],
"summary": "Add records to Hotlist",
"description": "Adds records to Hotlist.",
"operationId": "addToHotlist",
"parameters": [
{
"name": "hotlist",
"in": "path",
"description": "ID of the hotlist to edit",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Add to Hotlist Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/addToHotlist"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Hotlist"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "422"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Invalid Hotlist ID"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/hotlists/{hotlist}/remove-record": {
"post": {
"tags": [
"Hotlists"
],
"summary": "Remove records from Hotlist",
"description": "Removes records from Hotlist.",
"operationId": "removeFromHotlist",
"parameters": [
{
"name": "hotlist",
"in": "path",
"description": "ID of the hotlist to edit",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Remove from Hotlist Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/removeFromHotlist"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Hotlist"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/hotlists/search": {
"get": {
"tags": [
"Hotlists"
],
"summary": "Search for hotlists",
"description": "Returns all hotlists associated with your account that matched the search.",
"operationId": "searchHotlists",
"parameters": [
{
"name": "related_to_type",
"in": "query",
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "Hotlist Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "shared",
"in": "query",
"description": "Hotlist Shared status",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HotlistsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/pitch/{candidate}/contact/{contact}": {
"post": {
"tags": [
"Candidates"
],
"summary": "Pitch candidate to contact",
"description": "Mark the candidate as Pitched to the contact",
"operationId": "",
"parameters": [
{
"name": "created_by",
"in": "query",
"description": "Created By",
"schema": {
"type": "integer"
}
},
{
"name": "candidate",
"in": "path",
"description": "Candidate's Slug",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contact",
"in": "path",
"description": "Contact's Slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Candidate Pitched Successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"successCode": {
"description": "Success Code",
"type": "number",
"example": 200
},
"message": {
"description": "Success Message",
"type": "string",
"example": "Candidate Pitched Successfully"
},
"data": {
"$ref": "#/components/schemas/PitchToContact"
}
},
"type": "object"
},
"examples": {
"Example 1": {
"value": {
"success": true,
"successCode": 200,
"message": "Candidate Pitched Successfully",
"data": {
"candidate_slug": "9716881141193400000005acO",
"contact_slug": "16850938893970000005dqm",
"status_id": 6,
"stage_date": "2020-03-25T16:14:28.000000Z",
"remark": "Marked as Pitched",
"created_on": "2020-03-28T16:14:28.000000Z",
"created_by": 5,
"updated_on": "2020-03-28T16:14:28.000000Z",
"updated_by": 5
}
}
}
}
}
}
},
"404": {
"description": "Doesn't Exist",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/pitch/pitch-candidate-history/{candidate}": {
"get": {
"tags": [
"Candidates"
],
"summary": "Pitch History of a Candidate",
"description": "Get Pitch History of a Candidate",
"operationId": "PitchStage",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "Candidate Slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History Fetched successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PitchCandidateHistory"
}
}
}
},
"message": {
"type": "string"
},
"status": {
"type": "string"
},
"status code": {
"type": "integer"
}
}
},
"examples": {
"Example 1": {
"value": {
"data": {
"records": [
{
"contact_slug": "16490671235850000005LSk",
"status_id": 1,
"candidate_status": "Pitched",
"remark": "It is marked as pitched",
"stage_date": "2023-06-29T05:36:22.000000Z",
"updated_by": 5,
"created_on": "2023-06-29T05:36:22.000000Z",
"updated_on": "2023-06-29T05:36:22.000000Z"
}
]
},
"message": "string",
"status": "string",
"status code": 0
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Candidate doesn't exist",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean"
},
"errorCode": {
"type": "integer",
"example": 404
},
"errorMessage": {
"type": "string",
"example": "Candidate doesn't exist"
}
}
}
}
}
}
}
}
},
"/v1/pitch/pitch-contact-history/{contact}": {
"get": {
"tags": [
"Candidates"
],
"summary": "Pitch History of a Contact",
"description": "Get Pitch History of a Contact",
"operationId": "contactHistory",
"parameters": [
{
"name": "contact",
"in": "path",
"description": "Contact's Slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History fetched successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PitchContactHistory"
}
}
}
},
"message": {
"type": "string"
},
"status": {
"type": "string"
},
"status code": {
"type": "integer"
}
}
},
"examples": {
"Example 1": {
"value": {
"data": {
"records": [
{
"candidate_slug": "18390671235850000005LSk",
"status_id": 1,
"candidate_status": "Pitched",
"remark": "It is marked as pitched",
"stage_date": "2023-06-29T05:36:22.000000Z",
"updated_by": 5,
"created_on": "2023-06-29T05:36:22.000000Z",
"updated_on": "2023-06-29T05:36:22.000000Z"
}
]
},
"message": "string",
"status": "string",
"status code": 0
}
}
}
}
}
},
"404": {
"description": "Contact doesn't exist",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean"
},
"errorCode": {
"type": "integer",
"example": 404
},
"errorMessage": {
"type": "string",
"example": "Contact doesn't exist"
}
}
}
}
}
}
}
}
},
"/v1/pitch/{candidate}/history/{contact}": {
"get": {
"tags": [
"Candidates"
],
"summary": "Pitch History of a Candidate and Contact ",
"description": "Get Pitch History of a Candidate and Contact",
"operationId": "pitchHistory",
"parameters": [
{
"name": "candidate",
"in": "path",
"description": "Candidate's Slug",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contact",
"in": "path",
"description": "Contact's Slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "History fetched successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PitchHistory"
}
}
}
},
"message": {
"type": "string"
},
"status": {
"type": "string"
},
"status code": {
"type": "integer"
}
}
},
"examples": {
"Example 1": {
"value": {
"data": {
"records": [
{
"status_id": 10,
"candidate_status": "Pitched",
"remark": "Pitch History",
"stage_date": "2023-12-28T17:56:37.000000Z",
"updated_by": "5",
"created_on": "2023-12-28T17:56:37.000000Z",
"updated_on": "2023-12-28T17:56:37.000000Z"
}
]
},
"message": "string",
"status": "string",
"status code": 0
}
}
}
}
}
},
"404": {
"description": "Candidate or Contact doesn't exist",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean"
},
"errorCode": {
"type": "integer",
"example": 404
},
"errorMessage": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/v1/pitch/{candidate}/updated-stage/{contact}": {
"post": {
"tags": [
"Candidates"
],
"summary": "Update Pitch stage",
"description": "Update the Candidate's Pitched Stage",
"operationId": "updatePitchStage",
"parameters": [
{
"name": "updated_by",
"in": "query",
"description": "Updated By",
"schema": {
"type": "integer"
}
},
{
"name": "candidate",
"in": "path",
"description": "Candidate's Slug",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contact",
"in": "path",
"description": "Contact's Slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePitchStageRequest"
}
}
}
},
"responses": {
"200": {
"description": "Stage updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"successCode": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/UpdatePitchStageResponse"
}
}
},
"examples": {
"Example 1": {
"value": {
"success": true,
"successCode": 0,
"message": "string",
"data": {
"candidate_slug": "12345",
"contact_slug": "34234",
"status_id": 1,
"stage_date": "2020-03-25T16:14:28.000000Z",
"remark": "updated remark",
"created_on": "2020-03-25T16:14:28.000000Z",
"created_by": 123,
"updated_on": "2020-03-25T16:14:28.000000Z",
"updated_by": 123
}
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/v1/pitch/{entity}/pitch-stage/{entitySlug}": {
"get": {
"tags": [
"Candidates"
],
"summary": "Get contacts where the candidate is pitched",
"description": "Get the contacts where the candidate is pitched or Get candidates pitched to the Contact",
"operationId": "",
"parameters": [
{
"name": "entity",
"in": "path",
"description": "Entity - candidate/contact
candidate(Get contacts where the candidate is pitched)
Or contact(Get candidates pitched to the Contact)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entitySlug",
"in": "path",
"description": "Add Candidate Slug if entity is candidate or add Contact Slug if entity is contact",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"data": {
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PitchCandidateData"
}
}
}
}
}
},
"examples": {
"Example 1": {
"value": {
"status": "string",
"statusCode": 0,
"data": {
"records": [
{
"candidate_slug": "16448144215000000005eFC",
"contact_slug": "16739479639090000005Vsm",
"stage_date": "2023-12-15T15:26:45.000000Z",
"status_id": 1,
"candidate_status": "Pitched",
"remark": "Remark addded",
"contact_title": "string",
"contact_profile_pic": "string",
"contact_name": "Nicole",
"contact_email": "nicole@gmail.com",
"contact_number": "7891781919",
"candidate_profile_pic": "string",
"candidate_name": "Wyn Mattheis",
"candidate_email": "wyn@testmail.com",
"candidate_contact_number": 62819910101,
"resume": "string",
"candidate_position": "Development team lead",
"created_by": "5",
"created_on": "2023-12-15T15:26:45.000000Z",
"updated_by": "1001",
"updated_on": "2023-12-15T15:26:45.000000Z",
"resume_file_name": "string",
"candidate_email_opt_out": "0",
"contact_email_opt_out": "0"
}
]
}
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/v1/jobs": {
"get": {
"tags": [
"Jobs"
],
"summary": "Show all Jobs",
"description": "Returns all jobs associated with your account.",
"operationId": "showAllJobs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"schema": {
"type": "string",
"enum": [
"createdon",
"updatedon"
],
"default": "updatedon"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
},
"post": {
"tags": [
"Jobs"
],
"summary": "Creates a new Job",
"description": "Creates a new Job.",
"operationId": "storeJob",
"requestBody": {
"description": "Job Object",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"description": "",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"job_status": {
"type": "number",
"description": "`0` - Closed Job, `1` - Open Job, `2` - On-Hold Job, `3` - Cancelled Job, `Custom Id` - Custom Job Status"
},
"number_of_openings": {
"type": "number"
},
"company_slug": {
"type": "number"
},
"contact_slug": {
"type": "number"
},
"secondary_contact_slugs": {
"type": "number"
},
"job_description_text": {
"type": "string",
"minLength": 1
},
"job_description_file": {
"type": "string",
"format": "binary"
},
"minimum_experience": {
"type": "number"
},
"maximum_experience": {
"type": "number"
},
"salary_type": {
"type": "number"
},
"currency_id": {
"type": "number"
},
"min_annual_salary": {
"type": "number"
},
"max_annual_salary": {
"type": "number"
},
"qualification_id": {
"type": "number"
},
"specialization": {
"type": "string"
},
"job_skill": {
"type": "string",
"minLength": 1
},
"job_type": {
"type": "number",
"enum": [
1,
2,
3,
4
],
"description": "`1` - Part Time, `2` - Full Time, `3` - Contract, `4` - Contract to Permanent"
},
"pay_rate": {
"type": "number"
},
"bill_rate": {
"type": "number"
},
"job_category": {
"type": "string",
"minLength": 1
},
"city": {
"type": "string",
"minLength": 1
},
"locality": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string"
},
"country": {
"type": "string",
"minLength": 1
},
"address": {
"type": "string"
},
"show_company_logo": {
"type": "number"
},
"job_questions": {
"type": "string"
},
"collaborator_user_ids": {
"type": "string",
"description": "Comma separated user IDs",
"example": "\"1142, 1137\""
},
"collaborator_team_ids": {
"type": "string",
"description": "Comma separated team IDs",
"example": "\"16,17\""
},
"xml_feeds": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "1,2",
"description": "comma seperated string of default boards ids."
},
"custom": {
"type": "string",
"example": "1089,1086",
"description": "comma seperated string of custom boards ids."
}
}
},
"enable_auto_populate_teams": {
"type": "boolean",
"description": "Providing '1' as value will include all teams of the user provided in created_by, if added; otherwise, it will include teams of the account owner, unless explicitly provided in collaborator_team_ids"
},
"note_for_candidates": {
"type": "string",
"minLength": 1
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"custom_fields": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"field_id": {
"type": "number"
},
"value": {
"type": "string",
"minLength": 1
}
}
}
},
"enable_job_application_form": {
"type": "number"
},
"hiring_pipeline_id": {
"type": "number"
},
"job_location_type": {
"type": "number",
"enum": [
"0",
"1",
"2"
],
"description": "`0` - On-Site, `1` - Remote, `2` - Hybrid"
},
"postal_code": {
"type": "string"
},
"targetcompanies": {
"type": "string",
"description": "Comma separated company slugs\n",
"example": "\"321az,433dd\""
}
},
"required": [
"name",
"number_of_openings",
"company_slug",
"contact_slug",
"job_description_text",
"currency_id",
"enable_job_application_form"
]
},
"examples": {
"Example": {
"value": {
"name": "Customer Success Manager",
"number_of_openings": 5,
"company_slug": 33243,
"contact_slug": 3445,
"secondary_contact_slugs": 3445,
"job_description_text": "Description Text",
"job_description_file": "file",
"minimum_experience": 5,
"maximum_experience": 20,
"salary_type": 1,
"currency_id": 2,
"min_annual_salary": 500000,
"max_annual_salary": 800000,
"qualification_id": 4,
"specialization": "",
"city": "New York",
"locality": "Manhattan",
"state": "",
"country": "US",
"address": "",
"show_company_logo": 1,
"job_questions": "",
"collaborator_user_ids": "",
"collaborator_team_ids": "",
"note_for_candidates": "Please bring all original documents",
"custom_fields": [
{
"field_id": 1,
"value": "U"
}
],
"enable_job_application_form": 1,
"hiring_pipeline_id": 1,
"job_location_type": "1",
"postal_code": "110001"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobAdditional"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/jobs/{job}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Find job by slug",
"description": "Returns a single job",
"operationId": "showJob",
"parameters": [
{
"name": "job",
"in": "path",
"description": "slug of the job to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Job"
}
}
}
},
"404": {
"description": "Job doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Job doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Jobs"
],
"summary": "Edit a Job",
"description": "Edit a Job.",
"operationId": "editJob",
"parameters": [
{
"name": "job",
"in": "path",
"description": "slug of the Job to edit",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Job Object",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"description": "",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"number_of_openings": {
"type": "number"
},
"company_slug": {
"type": "number"
},
"contact_slug": {
"type": "number"
},
"secondary_contact_slugs": {
"type": "number"
},
"job_description_text": {
"type": "string",
"minLength": 1
},
"job_description_file": {
"type": "string",
"format": "binary"
},
"minimum_experience": {
"type": "number"
},
"maximum_experience": {
"type": "number"
},
"salary_type": {
"type": "number"
},
"currency_id": {
"type": "number"
},
"min_annual_salary": {
"type": "number"
},
"max_annual_salary": {
"type": "number"
},
"qualification_id": {
"type": "number"
},
"specialization": {
"type": "string"
},
"job_skill": {
"type": "string",
"minLength": 1
},
"job_type": {
"type": "number",
"enum": [
1,
2,
3,
4
],
"description": "`1` - Part Time, `2` - Full Time, `3` - Contract, `4` - Contract to Permanent"
},
"pay_rate": {
"type": "number"
},
"bill_rate": {
"type": "number"
},
"job_category": {
"type": "string",
"minLength": 1
},
"job_status": {
"type": "number"
},
"job_status_comment": {
"type": "string"
},
"city": {
"type": "string",
"minLength": 1
},
"locality": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string"
},
"country": {
"type": "string",
"minLength": 1
},
"address": {
"type": "string"
},
"show_company_logo": {
"type": "number"
},
"job_questions": {
"type": "string"
},
"collaborator_user_ids": {
"type": "string",
"description": "Comma separated user IDs",
"example": "\"1142, 1137\""
},
"collaborator_team_ids": {
"type": "string",
"description": "Comma separated team IDs",
"example": "\"16,17\""
},
"xml_feeds": {
"type": "object",
"properties": {
"default": {
"type": "string",
"example": "1,2",
"description": "comma seperated string of default boards ids."
},
"custom": {
"type": "string",
"example": "1089,1086",
"description": "comma seperated string of custom boards ids."
}
}
},
"note_for_candidates": {
"type": "string",
"minLength": 1
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"hiring_pipeline_id": {
"type": "number"
},
"custom_fields": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"field_id": {
"type": "number"
},
"value": {
"type": "string",
"minLength": 1
}
}
}
},
"enable_job_application_form": {
"type": "number"
},
"job_location_type": {
"type": "number",
"enum": [
"0",
"1",
"2"
],
"description": "`0` - On-Site, `1` - Remote, `2` - Hybrid"
},
"postal_code": {
"type": "string"
},
"targetcompanies": {
"type": "string",
"example": "\"321az,433dd\"",
"description": "Comma separated company slugs"
}
}
},
"examples": {
"Example": {
"value": {
"name": "Customer Success Manager",
"number_of_openings": 5,
"company_slug": 33243,
"contact_slug": 3445,
"secondary_contact_slugs": 3445,
"job_description_text": "Description Text",
"job_description_file": "file",
"minimum_experience": 5,
"maximum_experience": 20,
"salary_type": 1,
"currency_id": 2,
"min_annual_salary": 500000,
"max_annual_salary": 800000,
"qualification_id": 4,
"specialization": "",
"city": "New York",
"locality": "Manhattan",
"state": "",
"country": "US",
"address": "",
"show_company_logo": 1,
"job_questions": "",
"collaborator": "",
"note_for_candidates": "Please bring all original documents",
"custom_fields": [
{
"field_id": 1,
"value": "U"
}
],
"enable_job_application_form": 1,
"job_location_type": 1,
"postal_code": "110001"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Job"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Jobs"
],
"summary": "Delete a Job",
"description": "Delete a Job.",
"operationId": "deleteJob",
"parameters": [
{
"name": "job",
"in": "path",
"description": "slug of the Job to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Job doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Job doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/jobs/search": {
"get": {
"tags": [
"Jobs"
],
"summary": "Search for jobs",
"description": "Returns all jobs associated with your account that matched the search.(Enter at least one additional parameter apart from 'sort_by' and 'sort_order' to get the search result.)",
"operationId": "searchJobs",
"parameters": [
{
"name": "name",
"in": "query",
"description": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "job_status",
"in": "query",
"description": "Job Status",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "note_for_candidates",
"in": "query",
"description": "Note For Candidate",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "full_address",
"in": "query",
"description": "Full Address",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "city",
"in": "query",
"description": "City",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "country",
"in": "query",
"description": "Country",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "locality",
"in": "query",
"description": "Locality",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "company_name",
"in": "query",
"description": "Company Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "company_slug",
"in": "query",
"description": "Company Slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contact_slug",
"in": "query",
"description": "Contact Slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contact_name",
"in": "query",
"description": "Contact Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contact_email",
"in": "query",
"description": "Contact Email",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contact_number",
"in": "query",
"description": "Contact Number",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "secondary_contact_name",
"in": "query",
"description": "Secondary Contact Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "secondary_contact_slug",
"in": "query",
"description": "Secondary Contact Slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "secondary_contact_email",
"in": "query",
"description": "Secondary Contact Email",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "secondary_contact_number",
"in": "query",
"description": "Secondary Contact Number",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "job_type",
"in": "query",
"description": "`1` - Part Time, `2` - Full Time, `3` - Contract, `4` - Contract to Permanent",
"required": false,
"schema": {
"type": "number",
"enum": [
1,
2,
3,
4
]
}
},
{
"name": "job_skill",
"in": "query",
"description": "Job Skill",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "job_category",
"in": "query",
"description": "Job Category",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "created_from",
"in": "query",
"description": "Created (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "created_to",
"in": "query",
"description": "Created (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_from",
"in": "query",
"description": "Updated (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_to",
"in": "query",
"description": "Updated (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"schema": {
"type": "string",
"default": "updatedon",
"enum": [
"createdon",
"updatedon"
]
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
]
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "job_slug",
"description": "Job Slug (If this filter is applied then other filters will be ignored)"
},
{
"name": "owner_id",
"in": "query",
"description": "Owner Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_name",
"in": "query",
"description": "Owner Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_email",
"in": "query",
"description": "Owner Email",
"required": false,
"schema": {
"type": "string"
}
},
{
"schema": {
"type": "string",
"enum": [
"true",
"false",
"1",
"0"
]
},
"in": "query",
"name": "exact_search",
"description": "If value of exact_search is true/1 then exact search will be performed else like search will be performed"
},
{
"name": "limit",
"in": "query",
"description": "Limit per Page. Default 100 records per page.",
"required": false,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "#### Search By custom Fields\nClick [here](https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjEyMzU5OTgw-custom-field) to know more about ``Supported Filter Types``",
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldSearch"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/jobs/{job}/assigned-candidates": {
"get": {
"tags": [
"Jobs"
],
"summary": "Assigned candidates for job",
"description": "Return list of assigned candidates for requested job",
"operationId": "assignedCandidatesForJob",
"parameters": [
{
"name": "job",
"in": "path",
"description": "slug of the job to return",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number for records",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status_id",
"in": "query",
"description": "Hiring Stage Id (Supports single or comma-separated values)",
"required": false,
"schema": {
"type": "integer",
"example": "1243,2813"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignedCandidatesList"
}
}
}
}
}
}
},
"/v1/jobs/{job}/stage-history/{candidate}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Stage History of Candidate for job",
"description": "Return list of stage history of candidates for requested job",
"operationId": "candidateStageHistoryForJob",
"parameters": [
{
"name": "job",
"in": "path",
"description": "slug of the job",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "candidate",
"in": "path",
"description": "slug of the candidate",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Page number for records",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateHistoryList"
}
}
}
}
}
}
},
"/v1/jobs/application-form": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get Job Application Form",
"description": "Returns the job application form for a job based on the job_slug.",
"operationId": "getJobApplicationForm",
"parameters": [
{
"name": "job_slug",
"in": "query",
"description": "The slug of the job for which to retrieve the application form.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "success"
},
"data": {
"type": "object",
"properties": {
"job_application_form_data": {
"type": "object",
"properties": {
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "Personal Information"
},
"subtitle": {
"type": "string",
"example": "Please fill in your personal details"
},
"position": {
"type": "integer",
"example": 1
},
"required": {
"type": "boolean",
"example": true
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldId": {
"type": [
"integer",
"null"
],
"example": 1
},
"fieldName": {
"type": "string",
"example": "first_name"
},
"fieldLabel": {
"type": "string",
"example": "First Name"
},
"fieldType": {
"type": [
"string",
"null"
],
"example": "text"
},
"placeholder": {
"type": "string",
"example": "John"
},
"required": {
"type": "boolean",
"example": true
},
"position": {
"type": "integer",
"example": 1
},
"defaultValue": {
"type": [
"string",
"null"
],
"example": null
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Error to fetch job",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "integer",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Error to fetch job"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/jobs/list-xml-jobboards": {
"get": {
"summary": "Get XML Job-Boards List",
"tags": [
"Jobs"
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"x-examples": {
"Example 1": {
"default_xml_feeds": [
{
"id": 1,
"label": "Free Job Boards"
}
],
"custom_xml_feeds": [
{
"id": 11,
"label": "Xing 323"
},
{
"id": 27,
"label": "test"
}
]
}
},
"properties": {
"default_xml_feeds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1,
"description": "ID of Jobboard"
},
"label": {
"type": "string",
"example": "Indeed",
"description": "Label of Jobboard"
}
}
}
},
"custom_xml_feeds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 322,
"description": "ID of Jobboard"
},
"label": {
"type": "string",
"example": "CustomXML",
"description": "Label Of Jobboard"
}
}
}
}
}
},
"examples": {
"Example 1": {
"value": {
"default_xml_feeds": [
{
"id": 1,
"label": "Free Job Boards"
}
],
"custom_xml_feeds": [
{
"id": 11,
"label": "Xing 323"
},
{
"id": 27,
"label": "test"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"operationId": "get-jobs-list-xml-jobboards",
"parameters": [],
"requestBody": {
"content": {}
}
}
},
"/v1/jobs/application-form-metadata": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get job application form metadata",
"description": "Provides social media sharing text and image metadata for the job application form.",
"operationId": "getApplicationFormMetadata",
"parameters": [],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"social_sharing_apply_to": {
"type": "string",
"example": "string"
},
"social_sharing_with": {
"type": "string",
"example": "string"
},
"image_url": {
"type": "string",
"format": "uri",
"example": "https://example.com/social-job-image.png"
},
"image_filename": {
"type": "string",
"example": "social-job-image.png"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/jobs/compliance-terms": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get compliance terms",
"description": "Returns candidate GDPR, EEO policy, and SMS terms.",
"operationId": "getComplianceTerms",
"parameters": [],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"candidate_terms": {
"type": "string",
"example": "Your custom GDPR terms go here."
},
"eeo_policy": {
"type": "string",
"example": "Your EEO policy text here."
},
"sms_terms": {
"type": "string",
"example": "Your SMS communication terms here."
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/subscriptions": {
"get": {
"tags": [
"Webhook Subscriptions"
],
"summary": "Show all subscriptions",
"description": "Returns all subscriptions associated with your account.",
"operationId": "showAllSubscriptions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page.",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
},
"post": {
"tags": [
"Webhook Subscriptions"
],
"summary": "Creates a new subscription",
"description": "\n\n List of available events\n \n| Event Name | Event | Resource|\n|:--------------------------------------------------------|:-----------------------------------|:----------|\n| **Candidate Assigned** | candidate.assigned | Candidate |\n| **Candidate Created** | candidate.created | Candidate |\n| **Candidate Created from Talent Pool** | candidate.created.talentpool | Candidate |\n| **Candidate Updated** | candidate.updated | Candidate |\n| **Candidate Updated from External Profile Update Form** | candidate.external.profile.updated | Candidate |\n| **Candidate Deleted** | candidate.deleted | Candidate |\n| **Applied for Job from External Form** | candidate.external.applied.jobs | Candidate |\n| **Client Feedback Received** | candidate.clientfeedback.received | Candidate |\n| **Candidate's Hiring Stage Updated** | candidate.hiringstage.updated | Candidate |\n| **Contact Created** | contact.created | Contact |\n| **Contact Updated** | contact.updated | Contact |\n| **Contact Deleted** | contact.deleted | Contact |\n| **Company Created** | company.created | Company |\n| **Company Updated** | company.updated | Company |\n| **Company Deleted** | company.deleted | Company |\n| **Job Created** | job.created | Job |\n| **Job Updated** | job.updated | Job |\n| **Job Deleted** | job.deleted | Job |\n| **Job Status Updated** | job.status.updated | Job |\n| **Deal Created** | deal.created | Deal |\n| **Deal Updated** | deal.updated | Deal |\n| **Deal Deleted** | deal.deleted | Deal |\n| **Deal Stage Updated** | deal.stage.updated | Deal |\n| **Meeting Created** | meeting.created | Meeting |\n| **Meeting Updated** | meeting.updated | Meeting |\n| **Meeting Deleted** | meeting.deleted | Meeting |\n| **Task Created** | task.created | Task |\n| **Task Updated** | task.updated | Task |\n| **Task Deleted** | task.deleted | Task |\n| **Note Created** | note.created | Note |\n| **Note Updated** | note.updated | Note |\n| **Note Deleted** | note.deleted | Note |\n| **Call Log Created** | calllog.created | Call Log |\n| **Call Log Updated** | calllog.updated | Call Log |\n| **Call Log Deleted** | calllog.deleted | Call Log |\n| **File Uploaded** | file.uploaded | File |\n| **Candidate Opted Out** | candidate.optedout | Candidate | \n| **Candidate Opted In** | candidate.optedin | Candidate | \n| **Contact Opted Out** | contact.optedout | Contact | \n| **Contact Opted In** | contact.optedin | Contact | \n| **Candidate Enrolled in Sequence** | candidate.enrolled | Candidate | \n| **Candidate Unenrolled from Sequence** | candidate.unenrolled | Candidate | \n| **Contact Enrolled in Sequence** | contact.enrolled | Contact | \n| **Contact Unenrolled from Sequence** | contact.unenrolled | Contact |\n| **Hotlist Created** | hotlist.created | Hotlist |\n| **Hotlist Updated** | hotlist.updated | Hotlist |\n| **Record Added to Hotlist** | hotlist.record.added | Hotlist |\n| **Record Removed from Hotlist** | hotlist.record.removed | Hotlist |\n| **Candidate Pitched** | candidate.pitched | Candidate |\n| **Pitch Stage Updated** | candidate.pitch.updated | Candidate |\n| **Candidate Profile Update Requested** | candidate.profile.update.requested | Candidate |\n| **Candidate Unassigned from the Job** | candidate.unassigned | Candidate |\n| **Candidate Offlimit Updated** | candidate_offlimit.updated | Candidate ||\n| **Company Offlimit Updated** | company_offlimit.updated | Company ||\n| **Contact Offlimit Updated** | contact_offlimit.updated | Contact ||\n| **Candidate Available** | candidate_available.removed | Candidate ||\n| **Company Available** | company_available.removed | Company ||\n| **Contact Available** | contact_available.removed | Contact ||\n| **Draft Created** | draft.created | Email ||\n| **Target Achieved** | target.achieved | Target Reports |",
"operationId": "storeSubscription",
"requestBody": {
"description": "Subscription Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/subscriptions/{subscription}": {
"get": {
"tags": [
"Webhook Subscriptions"
],
"summary": "Find subscription by ID",
"description": "Returns a single subscription",
"operationId": "showSubscription",
"parameters": [
{
"name": "subscription",
"in": "path",
"description": "ID of the subscription",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"404": {
"description": "Subscription doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Webhook Subscriptions"
],
"summary": "Edit a subscription",
"description": "Edit a subscription.",
"operationId": "editSubscription",
"parameters": [
{
"name": "subscription",
"in": "path",
"description": "ID of the subscription to edit",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Subscription Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Subscription doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Webhook Subscriptions"
],
"summary": "Delete a subscription",
"description": "Delete a subscription.",
"operationId": "deleteSubscription",
"parameters": [
{
"name": "subscription",
"in": "path",
"description": "ID of the subscription to delete",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Subscription doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/meetings": {
"get": {
"tags": [
"Meetings"
],
"summary": "Show all meetings",
"description": "Returns all meetings associated with your account.",
"operationId": "showAllMeetings",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeetingsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
},
"post": {
"tags": [
"Meetings"
],
"summary": "Creates a new meeting",
"description": "Creates a new meeting.",
"operationId": "storeMeeting",
"requestBody": {
"description": "Meeting Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeetingRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Meeting"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/meetings/{meeting}": {
"get": {
"tags": [
"Meetings"
],
"summary": "Find meeting by ID",
"description": "Returns a single meeting",
"operationId": "showMeeting",
"parameters": [
{
"name": "meeting",
"in": "path",
"description": "ID of the meeting",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Meeting"
}
}
}
},
"404": {
"description": "Meeting doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Meeting doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Meetings"
],
"summary": "Edit meeting",
"description": "Edit meeting.",
"operationId": "editMeeting",
"parameters": [
{
"name": "meeting",
"in": "path",
"description": "ID of the meeting to edit",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Meeting Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditMeetingRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Meeting"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "422"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Invitation already sent to attendees and related to"
}
},
"type": "object"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Meetings"
],
"summary": "Delete a meeting",
"description": "Delete a meeting.",
"operationId": "deleteMeeting",
"parameters": [
{
"name": "meeting",
"in": "path",
"description": "ID of the meeting to delete",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Meeting doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Meeting doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/meetings/search": {
"get": {
"tags": [
"Meetings"
],
"summary": "Search for meetings",
"description": "Returns all meetings associated with your account that matched the search.",
"operationId": "searchMeetings",
"parameters": [
{
"name": "title",
"in": "query",
"description": "Title",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related_to",
"in": "query",
"description": "Related To",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "related_to_type",
"in": "query",
"description": "Related To Type",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "starting_from",
"in": "query",
"description": "Starting From",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "starting_to",
"in": "query",
"description": "Starting To",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "created_from",
"in": "query",
"description": "Created (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "created_to",
"in": "query",
"description": "Created (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_from",
"in": "query",
"description": "Updated (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_to",
"in": "query",
"description": "Updated (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_id",
"in": "query",
"description": "Owner Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_name",
"in": "query",
"description": "Owner Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_email",
"in": "query",
"description": "Owner Email",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeetingsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/tasks": {
"get": {
"tags": [
"Tasks"
],
"summary": "Show all tasks",
"description": "Returns all tasks associated with your account.",
"operationId": "showAllTasks",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
},
"post": {
"tags": [
"Tasks"
],
"summary": "Creates a new task",
"description": "Creates a new Task.",
"operationId": "storeTask",
"requestBody": {
"description": "Task Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Task"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/tasks/{task}": {
"get": {
"tags": [
"Tasks"
],
"summary": "Find task by ID",
"description": "Returns a single task",
"operationId": "showTask",
"parameters": [
{
"name": "task",
"in": "path",
"description": "ID of the task",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Task"
}
}
}
},
"404": {
"description": "Task doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Task doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Tasks"
],
"summary": "Edit task",
"description": "Edit task.",
"operationId": "editTask",
"parameters": [
{
"name": "task",
"in": "path",
"description": "ID of the task to edit",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Task Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditTaskRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Task"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Tasks"
],
"summary": "Delete a task",
"description": "Delete a task.",
"operationId": "deleteTask",
"parameters": [
{
"name": "task",
"in": "path",
"description": "ID of the task to delete",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Task doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Task doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/tasks/search": {
"get": {
"tags": [
"Tasks"
],
"summary": "Search for tasks",
"description": "Returns all tasks associated with your account that matched the search.",
"operationId": "searchTasks",
"parameters": [
{
"name": "title",
"in": "query",
"description": "Title",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related_to",
"in": "query",
"description": "Related To",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "related_to_type",
"in": "query",
"description": "Related To Type",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "starting_from",
"in": "query",
"description": "Starting From",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "starting_to",
"in": "query",
"description": "Starting To",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "created_from",
"in": "query",
"description": "Created (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "created_to",
"in": "query",
"description": "Created (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_from",
"in": "query",
"description": "Updated (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_to",
"in": "query",
"description": "Updated (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_id",
"in": "query",
"description": "Owner Id",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_name",
"in": "query",
"description": "Owner Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner_email",
"in": "query",
"description": "Owner Email",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TasksList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/call-logs": {
"get": {
"tags": [
"Call Logs"
],
"summary": "Show all Call Logs",
"description": "Returns all call logs associated with your account.",
"operationId": "showAllCallLogs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallLogsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
},
"post": {
"tags": [
"Call Logs"
],
"summary": "Creates a new Call Log",
"description": "Creates a new Call Log.",
"operationId": "storeCallLog",
"requestBody": {
"description": "Call Log Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallLogRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallLog"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/call-logs/{call_log}": {
"get": {
"tags": [
"Call Logs"
],
"summary": "Find call log by ID",
"description": "Returns a single call log",
"operationId": "showCallLog",
"parameters": [
{
"name": "call_log",
"in": "path",
"description": "ID of the call log to return",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "recording_required",
"in": "query",
"description": "Indicates if the recording link should be included",
"required": false,
"schema": {
"type": "string",
"enum": [
"true",
"false",
"1",
"0"
]
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallLogWithRecording"
}
}
}
},
"404": {
"description": "Call Log doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Call Log doesn't exist"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Validation Error",
"type": "string",
"example": "422"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Invalid value for recording_required"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Call Logs"
],
"summary": "Edit a call log",
"description": "Edit a call log.",
"operationId": "editCallLog",
"parameters": [
{
"name": "call_log",
"in": "path",
"description": "ID of the call log to edit",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Call Log Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditCallLogRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallLog"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Call Logs"
],
"summary": "Delete a call log",
"description": "Delete a call log.",
"operationId": "deleteCallLog",
"parameters": [
{
"name": "call_log",
"in": "path",
"description": "ID of the call log to delete",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Call Log doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Call Log doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/call-logs/search": {
"get": {
"tags": [
"Call Logs"
],
"summary": "Search for call logs",
"description": "Returns all call logs associated with your account that matched the search.",
"operationId": "searchCallLogs",
"parameters": [
{
"name": "related_to",
"in": "query",
"description": "Associated entity's slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related_to_type",
"in": "query",
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "call_type",
"in": "query",
"description": "Call Direction: For Outgoing Call - CALL_OUTGOING, Incoming Call - CALL_INCOMING",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "starting_from",
"in": "query",
"description": "Starting (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "starting_to",
"in": "query",
"description": "Starting (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_from",
"in": "query",
"description": "Updated (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_to",
"in": "query",
"description": "Updated (to date)",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallLogsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/call-logs/get-recording-status/{call_log}": {
"get": {
"tags": [
"Call Logs"
],
"summary": "Get Call Recording Upload Status",
"description": "Returns the call logs recording upload status. If the recording is uploaded, it will return the recording URL.",
"operationId": "showCallLogsRecordingUploadStatus",
"parameters": [
{
"name": "call_log",
"in": "path",
"description": "ID of the call log to return",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallLogWithRecording"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Call Log doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Call Log doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/call-logs/upload-call-recording": {
"post": {
"tags": [
"Call Logs"
],
"summary": "Upload Call Recordings",
"description": "Upload Call Recording to the existing call log.",
"operationId": "uploadFile",
"requestBody": {
"description": "File",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CallRecordingRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallRecordingResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Call Log doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Call Log doesn't exist"
}
},
"type": "object"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/notes": {
"get": {
"tags": [
"Notes"
],
"summary": "Show all Notes",
"description": "Returns all notes associated with your account.",
"operationId": "showAllNotes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotesList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
},
"post": {
"tags": [
"Notes"
],
"summary": "Creates a new Note",
"description": "Creates a new Note.",
"operationId": "storeNote",
"requestBody": {
"description": "Note Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Note"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/notes/{note}": {
"get": {
"tags": [
"Notes"
],
"summary": "Find note by ID",
"description": "Returns a single note",
"operationId": "showNote",
"parameters": [
{
"name": "note",
"in": "path",
"description": "ID of the note to return",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Note"
}
}
}
},
"404": {
"description": "Note doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Note doesn't exist"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Notes"
],
"summary": "Edit a note",
"description": "Edit a note.",
"operationId": "editNote",
"parameters": [
{
"name": "note",
"in": "path",
"description": "ID of the note to edit",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Note Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditNoteRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Note"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
}
},
"delete": {
"tags": [
"Notes"
],
"summary": "Delete a note",
"description": "Delete a note.",
"operationId": "deleteNote",
"parameters": [
{
"name": "note",
"in": "path",
"description": "ID of the note to delete",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"404": {
"description": "Note doesn't exist",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "boolean",
"example": true
},
"errorCode": {
"description": "Error Code",
"type": "string",
"example": "404"
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"example": "Note doesn't exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/v1/notes/search": {
"get": {
"tags": [
"Notes"
],
"summary": "Search for notes",
"description": "Returns all notes associated with your account that matched the search.",
"operationId": "searchNotes",
"parameters": [
{
"name": "related_to",
"in": "query",
"description": "Associated entity's slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "related_to_type",
"in": "query",
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "added_from",
"in": "query",
"description": "Added (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "added_to",
"in": "query",
"description": "Added (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_from",
"in": "query",
"description": "Updated (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_to",
"in": "query",
"description": "Updated (to date)",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotesList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/custom-fields": {
"get": {
"tags": [
"Custom Fields"
],
"summary": "Show all Custom Fields",
"description": "Returns all custom fields associated with your account.",
"operationId": "showAllCustomFields",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/custom-fields/candidates": {
"get": {
"tags": [
"Custom Fields"
],
"summary": "Show all Candidate Custom Fields",
"description": "Returns all candidate custom fields associated with your account.",
"operationId": "showCandidateCustomFields",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/custom-fields/contacts": {
"get": {
"tags": [
"Custom Fields"
],
"summary": "Show all Contact Custom Fields",
"description": "Returns all contact custom fields associated with your account.",
"operationId": "showContactCustomFields",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/custom-fields/companies": {
"get": {
"tags": [
"Custom Fields"
],
"summary": "Show all Company Custom Fields",
"description": "Returns all company custom fields associated with your account.",
"operationId": "showCompanyCustomFields",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/custom-fields/jobs": {
"get": {
"tags": [
"Custom Fields"
],
"summary": "Show all Job Custom Fields",
"description": "Returns all job custom fields associated with your account.",
"operationId": "showJobCustomFields",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/custom-fields/deals": {
"get": {
"tags": [
"Custom Fields"
],
"summary": "Show all Deal Custom Fields",
"description": "Returns all deal custom fields associated with your account.",
"operationId": "showDealCustomFields",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/custom-fields/job-associated": {
"get": {
"tags": [
"Custom Fields"
],
"summary": "Show all Job Associated Custom Fields",
"description": "Returns all job associated custom fields associated with your account.",
"operationId": "showJobAssociatedCustomFields",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/nested-custom-fields": {
"get": {
"tags": [
"Nested Custom Fields"
],
"summary": "Show Field Dependencies for all Entities",
"description": "Returns a list of all field dependencies associated with your account.\n\n**Note** : \n The parent field ID should be included in the payload of the Add/Edit endpoints for all entities to validate nested custom fields.",
"operationId": "showAllNestedFieldsDependency",
"parameters": [
{
"name": "entity_type",
"in": "query",
"description": "Accepts 'contacts', 'candidates', 'companies', 'jobs', and 'deals'",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "field_id",
"in": "query",
"description": "Custom Field ID to fetch the related field dependencies",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "dependency_id",
"in": "query",
"description": "Main (Top most) Parent Field ID to fetch the dependencies",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NestedFieldsList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
},
"post": {
"tags": [
"Call Logs"
],
"summary": "Creates a new Call Log",
"description": "Creates a new Call Log.",
"operationId": "storeCallLog",
"requestBody": {
"description": "Call Log Object",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallLogRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallLog"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/qualifications": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Qualifications",
"description": "Returns a list of qualifications",
"operationId": "getQualifications",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Qualification"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/off-limit-status": {
"get": {
"tags": [
"List Off Limit Status"
],
"summary": "Get Off Limit Status",
"description": "Returns a list of Off Limit Status",
"operationId": "getOffLimitStatus",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OffLimitStatus"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/currencies": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Currencies",
"description": "Returns a list of currencies",
"operationId": "getCurrencies",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Currency"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/salary-types": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Salary Types",
"description": "Returns a list of salary types",
"operationId": "getSalaryTypes",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"properties": {
"type_id": {
"type": "integer",
"example": 3
},
"label": {
"description": "Salary Label",
"type": "string",
"example": "Weekly Salary"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/industries": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Industries",
"description": "Returns a list of industries",
"operationId": "getIndustries",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Industry"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/languages": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Languages",
"description": "Returns a list of languages",
"operationId": "getLanguages",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Language"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/proficiencies": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Proficiencies",
"description": "Returns a list of proficiencies",
"operationId": "getProficiencies",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"properties": {
"proficiency_id": {
"type": "integer",
"example": 6
},
"label": {
"description": "Proficiency Label",
"type": "string",
"example": "Native or bilingual proficiency"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/custom-call-types": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Call Types ",
"description": "Returns a list of call types",
"operationId": "getCallTypes",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallType"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/note-types": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Note Types ",
"description": "Returns a list of note types",
"operationId": "getNoteTypes",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteType"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/meeting-types": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Meeting Types ",
"description": "Returns a list of meeting types",
"operationId": "getMeetingTypes",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeetingType"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/task-types": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Task Types ",
"description": "Returns a list of Task types",
"operationId": "getTaskTypes",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskType"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/sales-pipeline": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Contact Stages ",
"description": "Returns a list of stages in sales pipeline",
"operationId": "getSalesPipeline",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactStage"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/deals-pipeline": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Deals Stages ",
"description": "Returns a list of stages in deals pipeline",
"operationId": "getDealsPipeline",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealPipelineStage"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/jobs-pipeline": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Job Stages",
"description": "Returns a list of stages in jobs pipeline",
"operationId": "getJobsPipeline",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobStatus"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/hiring-pipeline": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Candidate Stages",
"description": "Returns a list of stages in hiring pipeline",
"operationId": "getHiringPipeline",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateStatus"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/hiring-pipelines": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Multiple Hiring Pipelines",
"description": "Returns a list of hiring pipelines",
"operationId": "getMultipleHiringPipeline",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MultipleHiringPipeline"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/hiring-pipelines/{id}": {
"get": {
"tags": [
"Lists"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the hiring pipeline whose stages needs to be returned. 0 is for Master Hiring Pipeline",
"required": true,
"schema": {
"type": "integer"
}
}
],
"summary": "Get Hiring Pipeline Stages For A Pipeline",
"description": "Returns a list of hiring stages for the requested pipeline",
"operationId": "getStagesForHiringPipeline",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateStatus"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"422": {
"description": "Invalid Pipeline ID"
}
}
}
},
"/v1/candidate-questions": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Candidate Questions",
"description": "Returns a list of candidate questions",
"operationId": "getCandidateQuestions",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CandidateQuestions"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/collaborators": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Collaborators",
"description": "Returns a list of collaborators",
"operationId": "getCollaborators",
"parameters": [
{
"name": "expand",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example": "team"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserWithTeams"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/users": {
"get": {
"tags": [
"Lists"
],
"summary": "Get All Users",
"description": "Returns a list of users",
"operationId": "getUsers",
"parameters": [
{
"name": "expand",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example": "team"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserWithTeams"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/users/search": {
"get": {
"tags": [
"Users"
],
"summary": "Search for Users",
"description": "Returns all users associated with your account that matched the search.",
"operationId": "searchUsers",
"parameters": [
{
"name": "first_name",
"in": "query",
"description": "First Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "last_name",
"in": "query",
"description": "Last Name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"in": "query",
"description": "Email",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contact_number",
"in": "query",
"description": "Contact Number",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "user_id",
"in": "query",
"description": "User ID",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "expand",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example": "team"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserWithTeams"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/files": {
"post": {
"tags": [
"Files"
],
"summary": "Upload new files",
"description": "Upload new files to entity file section",
"operationId": "uploadFile",
"requestBody": {
"description": "File",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FileRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/files/{entity}/{slug}": {
"get": {
"tags": [
"Files"
],
"summary": "Get All Files",
"description": "Returns all Files associated with your entity.",
"operationId": "getfiles",
"parameters": [
{
"name": "entity",
"in": "path",
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job/ deal",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "slug",
"in": "path",
"description": "Associated entity's slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/teams": {
"get": {
"tags": [
"Lists"
],
"summary": "Get All Teams",
"description": "Returns a list of teams",
"operationId": "getTeams",
"parameters": [
{
"name": "expand",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example": "users"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamWithUsers"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/target-report/get": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Target Report",
"description": "Returns a list of Target Reports",
"operationId": "getTargetReports",
"parameters": [
{
"schema": {
"type": "string",
"default": "updated_on"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"name": "sort_order",
"in": "query",
"description": "Sort order",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TargetReportList"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/pitch-pipeline": {
"get": {
"tags": [
"Lists"
],
"summary": "Get Pitch stages",
"description": "Returns a list of stages in Pitch Candidate pipeline",
"operationId": "getPitchStages",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PitchStages"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/enrollment-statuses": {
"get": {
"tags": [
"Sequences"
],
"summary": "Get All Enrollment Statuses",
"description": "Returns a list of Enrollment Statuses",
"operationId": "getEnrollmentStatuses",
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"properties": {
"status_id": {
"type": "integer",
"example": 1
},
"label": {
"description": "Status Label",
"type": "string",
"example": "ACTIVE"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/enrollments/search": {
"get": {
"tags": [
"Sequences"
],
"summary": "Search for Enrollments",
"description": "Returns all enrollments associated with your account that matched the search.",
"operationId": "searchEnrollments",
"parameters": [
{
"name": "enrollment_id",
"in": "query",
"description": "Enrollment ID",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "sequence_id",
"in": "query",
"description": "Sequence ID",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "prospect_slug",
"in": "query",
"description": "Prospect slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "prospect_type",
"in": "query",
"description": "Prospect type",
"schema": {
"type": "string",
"enum": [
"candidate",
"contact"
]
}
},
{
"name": "enrollment_status",
"in": "query",
"description": "Enrollment status",
"required": false,
"schema": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6
]
}
},
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"schema": {
"type": "string",
"enum": [
"enrolled_on",
"updated_on"
],
"default": "updated_on"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"name": "sort_order",
"in": "query",
"description": "Sort order",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"schema": {
"type": "integer"
}
},
{
"name": "expand",
"in": "query",
"required": false,
"description": "The acceptable values include sequence, enrolled_by, unenrolled_by, prospect or a combination of these. Alternatively, an asterisk (*) can be used to expand all options.",
"schema": {
"type": "string"
},
"example": "sequence"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnrollmentList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/email-sequences/search": {
"get": {
"tags": [
"Sequences"
],
"summary": "Search for Sequences",
"description": "Returns all sequences associated with your account that matched the search.",
"operationId": "searchSequences",
"parameters": [
{
"name": "sequence_id",
"in": "query",
"description": "ID of the sequence",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "sequence_name",
"in": "query",
"description": "Name of the sequence",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "added_from",
"in": "query",
"description": "Added (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "added_to",
"in": "query",
"description": "Added (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_from",
"in": "query",
"description": "Updated (from date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "updated_to",
"in": "query",
"description": "Updated (to date)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"schema": {
"type": "string",
"enum": [
"created_on",
"updated_on"
],
"default": "updated_on"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
},
{
"schema": {
"type": "string",
"enum": [
"true",
"false",
"1",
"0"
]
},
"in": "query",
"name": "exact_search",
"description": "If value of exact_search is true/1 then exact search will be performed else like search will be performed"
},
{
"schema": {
"type": "string",
"enum": [
"candidate",
"contact"
]
},
"in": "query",
"name": "sequence_type",
"description": "Sequence type"
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"schema": {
"type": "integer"
}
},
{
"name": "expand",
"in": "query",
"required": false,
"description": "The acceptable values are either created_by or updated_by or a combination of both. Alternatively, you can use an asterisk (*) to expand both options.",
"schema": {
"type": "string"
},
"example": "created_by"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SequenceList"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/email/opted-out": {
"get": {
"tags": [
"Email"
],
"summary": "Opted out entities",
"description": "Get list of opted out entities.",
"operationId": "listOptedOut",
"parameters": [
{
"name": "related_to_type",
"in": "query",
"required": true,
"description": "Entity Type i.e. candidate/ contact",
"example": "candidate",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page Number for Pagination",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit of records per page. (Max:100)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"schema": {
"type": "string",
"enum": [
"createdon",
"updatedon"
],
"default": "updatedon"
},
"in": "query",
"name": "sort_by",
"description": "Sort by field"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"in": "query",
"name": "sort_order",
"description": "Sort order"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/CandidatesList"
},
{
"$ref": "#/components/schemas/ContactsList"
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
}
}
}
},
"/v1/email/opt-out/status": {
"post": {
"tags": [
"Email"
],
"summary": "Update Opted out status",
"description": "Update opted out status of an entity.",
"operationId": "updateOptedOutStatus",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"related_to",
"related_to_type",
"opt_out"
],
"properties": {
"related_to": {
"type": "string",
"description": "Entity slug i.e. candidate/ contact slug"
},
"related_to_type": {
"type": "string",
"description": "Entity type i.e. candidate/ contact"
},
"opt_out": {
"type": "boolean",
"description": "0: For Opt-in, 1: For Opt-out"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Candidate"
},
{
"$ref": "#/components/schemas/Contact"
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/v1/drafts": {
"post": {
"tags": [
"Email"
],
"summary": "Create Email Draft",
"description": "To create email drafts\n> This endpoint responds quickly using asynchronous processing. It may show a \"Network Error\" in some tools, but it works correctly in Postman and other API clients.",
"operationId": "createDraft",
"requestBody": {
"description": "Draft Object",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DraftRequest"
},
"examples": {
"Example": {
"$ref": "#/components/examples/DraftExample"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Draft"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
},
"x-stoplight": {
"id": "w8tya714zxub3"
},
"x-internal": false
}
},
"/v1/drafts/status/{draft_status_id}": {
"get": {
"tags": [
"Email"
],
"summary": "Draft Email Status",
"description": "To Check Draft Status",
"operationId": "draftStatus",
"requestBody": {
"description": "",
"required": true,
"content": {}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Draft-Success"
},
{
"$ref": "#/components/schemas/Draft-Processing"
},
{
"$ref": "#/components/schemas/Draft-Failed"
}
]
}
}
},
"headers": {}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
},
"x-stoplight": {
"id": "4k4er6cc6q201"
}
},
"parameters": [
{
"schema": {
"type": "string"
},
"name": "draft_status_id",
"in": "path",
"required": true,
"description": "Id to check Status Of Draft Created"
}
]
},
"/v1/emails": {
"post": {
"tags": [
"Email"
],
"summary": "Send an Email",
"description": "To send an email\n> This endpoint responds quickly using asynchronous processing. It may show a \"Network Error\" in some tools, but it works correctly in Postman and other API clients.",
"operationId": "sendEmail",
"requestBody": {
"description": "Send Email Object",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DraftRequest"
},
"examples": {
"Example": {
"$ref": "#/components/examples/DraftExample"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Email"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
},
"x-stoplight": {
"id": "bvaogh4298iyy"
}
}
},
"/v1/emails/status/{email_status_id}": {
"parameters": [
{
"schema": {
"type": "string"
},
"name": "email_status_id",
"in": "path",
"required": true,
"description": "Id to check Status Of Email Sent"
}
],
"get": {
"tags": [
"Email"
],
"summary": "Sent Email Status",
"description": "To Check Sent Email Status",
"operationId": "emailStatus",
"requestBody": {
"description": "",
"required": true,
"content": {}
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Email-Success"
},
{
"$ref": "#/components/schemas/Email-Processing"
},
{
"$ref": "#/components/schemas/Email-Failed"
}
]
}
}
},
"headers": {}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorUnauthorized"
}
}
}
},
"429": {
"description": "Unprocessable Entity"
}
},
"x-stoplight": {
"id": "v3h9wsdov0ibo"
}
}
}
},
"components": {
"schemas": {
"EnrollCandidate": {
"type": "object",
"properties": {
"id": {
"description": "Enrollment ID",
"type": "integer",
"example": 1
},
"sequence_id": {
"description": "Sequence ID",
"type": "integer",
"example": 124
},
"enrolled_by": {
"description": "Enrolled By",
"type": "integer",
"example": 10002
},
"unenrolled_by": {
"type": "integer",
"description": "Unenrolled By",
"example": 10002
},
"enrolled_on": {
"type": "string",
"description": "Enrolled On",
"example": "2022-12-02T16:53:27.000000Z"
},
"unenrolled_on": {
"type": "string",
"description": "Unenrolled On",
"example": "2022-12-02T16:53:27.000000Z"
},
"status": {
"description": "Enrollment's status",
"type": "object",
"example": {
"status_id": 1,
"label": "ACTIVE"
}
},
"prospect_slug": {
"type": "string",
"description": "Prospect slug",
"example": "16318617835190000051Ond"
},
"prospect": {
"type": "array",
"$ref": "#/components/schemas/Candidate"
}
}
},
"EnrollContact": {
"type": "object",
"properties": {
"id": {
"description": "Enrollment ID",
"type": "integer",
"example": 1
},
"sequence_id": {
"description": "Sequence ID",
"type": "integer",
"example": 124
},
"enrolled_by": {
"description": "Enrolled By",
"type": "integer",
"example": 10002
},
"unenrolled_by": {
"type": "integer",
"description": "Unenrolled By",
"example": 10002
},
"enrolled_on": {
"type": "string",
"description": "Enrolled On",
"example": "2022-12-02T16:53:27.000000Z"
},
"unenrolled_on": {
"type": "string",
"description": "Unenrolled On",
"example": "2022-12-02T16:53:27.000000Z"
},
"status": {
"description": "Enrollment's status",
"type": "object",
"example": {
"status_id": 1,
"label": "ACTIVE"
}
},
"prospect_slug": {
"type": "string",
"description": "Prospect slug",
"example": "16318617835190000051Ond"
},
"prospect": {
"type": "array",
"$ref": "#/components/schemas/Contact"
}
}
},
"EnrollmentList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Enrollments"
}
]
}
}
},
"type": "object"
}
]
},
"SequenceList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/SequenceDetail"
}
]
}
}
},
"type": "object"
}
]
},
"Enrollments": {
"type": "object",
"properties": {
"id": {
"description": "Enrollment ID",
"type": "integer",
"example": 1
},
"sequence_id": {
"description": "Sequence ID",
"type": "integer",
"example": 124
},
"enrolled_by": {
"description": "Enrolled By",
"type": "integer",
"example": 10002
},
"unenrolled_by": {
"type": "integer",
"description": "Unenrolled By",
"example": 10002
},
"enrolled_on": {
"type": "string",
"description": "Enrolled On",
"example": "2022-12-02T16:53:27.000000Z"
},
"unenrolled_on": {
"type": "string",
"description": "Unenrolled On",
"example": "2022-12-02T16:53:27.000000Z"
},
"status": {
"description": "Enrollment's status",
"type": "object",
"example": {
"status_id": 1,
"label": "ACTIVE"
}
},
"prospect_slug": {
"type": "string",
"description": "Prospect slug",
"example": "16318617835190000051Ond"
},
"prospect": {
"type": "array",
"$ref": "#/components/schemas/Contact"
},
"sequence": {
"type": "array",
"$ref": "#/components/schemas/SequenceDetail"
}
}
},
"SequenceDetail": {
"type": "object",
"properties": {
"id": {
"description": "Sequence ID",
"type": "integer",
"example": 1
},
"sequence_name": {
"description": "Sequence name",
"type": "string",
"example": "test seq"
},
"sequence_type": {
"description": "Sequence type",
"type": "string",
"example": "candidate"
},
"number_of_total_enrollment": {
"description": "number of total enrollments",
"type": "integer",
"example": 120
},
"number_of_active_enrollment": {
"description": "number of active enrollments",
"type": "integer",
"example": 24
},
"open_rate": {
"description": "Open rate",
"type": "number",
"format": "percent",
"example": 12.45
},
"reply_rate": {
"description": "Reply rate ",
"type": "number",
"format": "percent",
"example": 10.5
},
"unsubscribe_rate": {
"description": "Unsubscribe rate",
"type": "number",
"format": "percent",
"example": 1.4
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2022-12-02T16:53:27.000000Z"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2022-12-02T16:53:27.000000Z"
},
"created_by": {
"description": "Created By",
"type": "integer",
"example": 10002
},
"updated_by": {
"type": "integer",
"description": "Updated By",
"example": 10002
}
}
},
"Note": {
"type": "object",
"properties": {
"id": {
"description": "Note ID",
"type": "integer",
"example": 2
},
"note_type": {
"description": "Note Type",
"type": "array",
"example": [
{
"id": 1,
"label": "To Do"
}
],
"items": {
"allOf": [
{
"$ref": "#/components/schemas/NoteType"
}
]
}
},
"description": {
"description": "Note Description",
"type": "string",
"example": "Will be open for offer after 2 months"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job/ deal",
"type": "string",
"example": "candidate"
},
"associated_candidates": {
"type": "array",
"description": "Array of Associated Candidates",
"items": {
"type": "string",
"example": "123"
}
},
"associated_contacts": {
"type": "array",
"description": "Array of Associated Contacts",
"items": {
"type": "string",
"example": "2324"
}
},
"associated_companies": {
"type": "array",
"description": "Array of Associated Companies",
"items": {
"type": "string",
"example": "5435"
}
},
"associated_jobs": {
"type": "array",
"description": "Array of Associated Jobs",
"items": {
"type": "string",
"example": "432"
}
},
"associated_deals": {
"type": "array",
"description": "Array of Associated Deals",
"items": {
"type": "string",
"example": "42432"
}
},
"related": {
"type": "object",
"description": "Details Of Related Entity"
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2022-12-02T16:53:27.000000Z"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2022-12-02T16:53:27.000000Z"
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "10002"
},
"updated_by": {
"type": "string",
"description": "Updated By",
"example": "10002"
},
"collaborator_users": {
"description": "Array of user collaborators (BETA/Tagging)",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
]
}
},
"collaborator_teams": {
"description": "Array of team collaborators (BETA/Tagging)",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Team"
}
]
}
}
}
},
"NoteRequest": {
"type": "object",
"properties": {
"note_type_id": {
"description": "Note Type",
"type": "integer",
"example": 1
},
"description": {
"description": "Note Description",
"type": "string",
"example": "Will be open for offer after 2 months"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job/ deal",
"type": "string",
"example": "candidate"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"associated_candidates": {
"type": "string",
"description": "Comma separated candidate slugs",
"example": "275,16318617835190000051Ond"
},
"associated_companies": {
"type": "string",
"description": "Comma separated company slugs",
"example": "275,16318617835190000051Ond"
},
"associated_contacts": {
"type": "string",
"description": "Comma separated contact slugs",
"example": "275,16318617835190000051Ond"
},
"associated_jobs": {
"type": "string",
"description": "Comma separated job slugs",
"example": "275,16318617835190000051Ond"
},
"associated_deals": {
"type": "string",
"description": "Comma separated deal slugs",
"example": "275,16318617835190000051Ond"
},
"collaborator_user_ids": {
"type": "string",
"description": "Comma separated user IDs (BETA/Tagging)",
"example": "11496,11497"
},
"collaborator_team_ids": {
"type": "string",
"description": "Comma separated team IDs (BETA/Tagging)",
"example": "16,17"
},
"enable_auto_populate_teams": {
"type": "boolean",
"description": "Providing '1' as value will include all teams of the user provided in created_by, if added; otherwise, it will include teams of the account owner, unless explicitly provided in collaborator_team_ids.(BETA/Tagging)",
"example": "1"
}
},
"required": [
"description",
"related_to",
"related_to_type"
]
},
"EditNoteRequest": {
"type": "object",
"properties": {
"note_type_id": {
"description": "Note Type",
"type": "integer",
"example": 1
},
"description": {
"description": "Note Description",
"type": "string",
"example": "Will be open for offer after 2 months"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job/ deal",
"type": "string",
"example": "candidate"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"associated_candidates": {
"type": "string",
"description": "Comma separated candidate slugs",
"example": "275,16318617835190000051Ond"
},
"associated_companies": {
"type": "string",
"description": "Comma separated company slugs",
"example": "275,16318617835190000051Ond"
},
"associated_contacts": {
"type": "string",
"description": "Comma separated contact slugs",
"example": "275,16318617835190000051Ond"
},
"associated_jobs": {
"type": "string",
"description": "Comma separated job slugs",
"example": "275,16318617835190000051Ond"
},
"associated_deals": {
"type": "string",
"description": "Comma separated deal slugs",
"example": "275,16318617835190000051Ond"
},
"collaborator_user_ids": {
"type": "string",
"description": "Comma separated user IDs (BETA/Tagging)",
"example": "11496,11497"
},
"collaborator_team_ids": {
"type": "string",
"description": "Comma separated team IDs (BETA/Tagging)",
"example": "16,17"
},
"enable_auto_populate_teams": {
"type": "boolean",
"description": "Providing '1' as value will include all teams of the user provided in created_by, if added; otherwise, it will include teams of the account owner, unless explicitly provided in collaborator_team_ids.(BETA/Tagging)",
"example": "1"
}
}
},
"NotesList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Note"
}
]
}
}
},
"type": "object"
}
]
},
"UpdateHiringStage": {
"properties": {
"status_id": {
"description": "Candidate's status",
"type": "integer",
"example": 1
},
"remark": {
"description": "Remark",
"type": "string",
"example": "Updated"
},
"stage_date": {
"description": "Updated Date",
"type": "string",
"example": "2020-03-25T16:14:28.000000Z"
},
"updated_by": {
"description": "ID of the user",
"type": "integer",
"example": 1
}
},
"type": "object"
},
"addToHotlist": {
"properties": {
"related": {
"description": "Slug of record to be added to hotlist",
"type": "string",
"example": "22231"
}
},
"type": "object"
},
"removeFromHotlist": {
"properties": {
"related": {
"description": "Slug of record to be removed from hotlist",
"type": "string",
"example": "22231"
}
},
"type": "object"
},
"Subscription": {
"properties": {
"id": {
"description": "Subscription ID",
"type": "integer",
"example": 56
},
"event": {
"description": "Name of Subscribed Event",
"type": "string",
"example": "candidate.created"
},
"target_url": {
"description": "Subscription URL",
"type": "string",
"example": "https://someurl"
}
},
"type": "object"
},
"SubscriptionsList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Subscription"
}
]
}
}
},
"type": "object"
}
]
},
"AppliedJob": {
"properties": {
"candidate_slug": {
"description": "Candidate's Slug",
"type": "string",
"example": "1205129"
},
"job_slug": {
"description": "Job's Slug",
"type": "string",
"example": "1206683"
},
"status": {
"description": "Candidate's status",
"type": "object",
"example": {
"status_id": 1,
"label": "Applied"
}
},
"remark": {
"description": "Remark",
"type": "string",
"example": "Updated"
},
"stage_date": {
"description": "Updated Date",
"type": "string",
"example": "2020-03-25T16:14:28.000000Z"
},
"visibility": {
"description": "Candidate's visibility in a job: For On - 1, Off - 0",
"type": "integer",
"example": 1
},
"updated_on": {
"type": "string",
"description": "Record Updated Date",
"example": "2020-03-25T16:14:28.000000Z"
},
"updated_by": {
"type": "integer",
"example": 342552,
"description": "Updated by User Details"
},
"shared_list_url": {
"description": "URL of shared candidate list",
"type": "string",
"example": "https://recruitcrm.io/assigned_candidates/001"
}
},
"type": "object"
},
"AssignedJob": {
"properties": {
"candidate_slug": {
"description": "Candidate's Slug",
"type": "string",
"example": "1205129"
},
"job_slug": {
"description": "Job's Slug",
"type": "string",
"example": "1206683"
},
"status": {
"description": "Candidate's status",
"type": "object",
"example": {
"status_id": 1,
"label": "Assigned"
}
},
"remark": {
"description": "Remark",
"type": "string",
"example": "Updated"
},
"stage_date": {
"description": "Updated Date",
"type": "string",
"example": "2020-03-25T16:14:28.000000Z"
},
"visibility": {
"description": "Candidate's visibility in a job: For On - 1, Off - 0",
"type": "integer",
"example": 1
},
"shared_list_url": {
"description": "URL of shared candidate list",
"type": "string",
"example": "https://recruitcrm.io/assigned_candidates/001"
},
"updated_on": {
"type": "string",
"description": "Record Updated Date",
"example": "2020-03-25T16:14:28.000000Z"
},
"updated_by": {
"type": "integer",
"description": "Updated by User Details",
"example": 2354356
}
},
"type": "object"
},
"CandidateAssignedJob": {
"properties": {
"candidate_slug": {
"description": "Candidate's Slug",
"type": "string",
"example": "1205129"
},
"job_slug": {
"description": "Job's Slug",
"type": "string",
"example": "1206683"
},
"status": {
"description": "Candidate's status",
"type": "object",
"example": {
"status_id": 1,
"label": "Assigned"
}
},
"remark": {
"description": "Remark",
"type": "string",
"example": "Updated"
},
"stage_date": {
"description": "Updated Date",
"type": "string",
"example": "2020-03-25T16:14:28.000000Z"
},
"visibility": {
"description": "Candidate's visibility in a job: For On - 1, Off - 0",
"type": "integer",
"example": 1
},
"shared_list_url": {
"description": "URL of shared candidate list",
"type": "string",
"example": "https://recruitcrm.io/assigned_candidates/001"
},
"updated_on": {
"type": "string",
"description": "Record Updated Date",
"example": "2020-03-25T16:14:28.000000Z"
},
"updated_by": {
"description": "Updated by User Details",
"type": "object",
"example": {
"id": 123,
"first_name": "Erica",
"last_name": null,
"email": "erica@yopmail.com",
"contact_number": null,
"avatar": null
}
}
},
"type": "object"
},
"Attendee": {
"properties": {
"attendee_type": {
"description": "Type of Attendee i.e. candidate/ contact/ user",
"type": "string",
"example": "candidate"
},
"attendee_id": {
"description": "Attendee Slug",
"type": "string",
"example": "12654"
},
"display_name": {
"description": "Attendee Name",
"type": "string",
"example": "Michael Scott"
},
"attendee": {
"description": "Array of attendee details",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Candidate"
}
]
}
}
},
"type": "object"
},
"Collaborator": {
"properties": {
"attendee_type": {
"description": "Type of Attendee i.e. user",
"type": "string",
"example": "user"
},
"attendee_id": {
"description": "Attendee ID",
"type": "string",
"example": "12654"
},
"display_name": {
"description": "Attendee Name",
"type": "string",
"example": "Jane Scott"
},
"attendee": {
"description": "Array of collaborator details",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
]
}
}
},
"type": "object"
},
"CandidateHiringStageList": {
"allOf": [
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/AssignedJob"
}
]
}
}
]
},
"CandidateRequest": {
"description": "",
"type": "object",
"properties": {
"first_name": {
"type": "string",
"minLength": 1
},
"last_name": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"minLength": 1
},
"contact_number": {
"type": "string",
"minLength": 1
},
"avatar": {
"type": "string"
},
"gender_id": {
"type": "number"
},
"qualification_id": {
"type": "number",
"description": "To be deprecated, instead use Education History API"
},
"specialization": {
"type": "string",
"minLength": 1,
"description": "To be deprecated, instead use Education History API"
},
"work_ex_year": {
"type": "number"
},
"candidate_dob": {
"type": "string",
"minLength": 1
},
"profile_updated_on": {
"type": "string",
"minLength": 1
},
"current_salary": {
"type": "string",
"minLength": 1
},
"salary_expectation": {
"type": "string",
"minLength": 1
},
"willing_to_relocate": {
"type": "number"
},
"current_organization": {
"type": "string"
},
"current_organization_slug": {
"type": "string",
"description": "Company Slug for the Current Organization of the Candidate"
},
"current_status": {
"type": "string",
"minLength": 1
},
"notice_period": {
"type": "number"
},
"currency_id": {
"type": "number"
},
"facebook": {
"type": "string",
"minLength": 1
},
"twitter": {
"type": "string",
"minLength": 1
},
"linkedin": {
"type": "string",
"minLength": 1
},
"github": {
"type": "string"
},
"xing": {
"type": "string",
"minLength": 1
},
"city": {
"type": "string",
"minLength": 1
},
"locality": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"minLength": 1
},
"country": {
"type": "string",
"minLength": 1
},
"postal_code": {
"type": "string",
"minLength": 1
},
"address": {
"type": "string"
},
"relevant_experience": {
"type": "number"
},
"position": {
"type": "string",
"minLength": 1,
"description": "Position/Title of the candidate"
},
"available_from": {
"type": "string",
"minLength": 1
},
"salary_type": {
"type": "number"
},
"source": {
"type": "string",
"minLength": 1
},
"language_skills": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"language_id": {
"type": "number"
},
"proficiency_id": {
"type": "number"
}
}
}
},
"skill": {
"type": "string",
"minLength": 1
},
"resume": {
"type": [
"string",
"object"
],
"description": "Can be Public URL to file, or File (form-data)"
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"custom_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_id": {
"type": "integer"
},
"value": {
"type": "string"
}
}
}
},
"candidate_summary": {
"type": "string"
}
},
"required": [
"first_name"
]
},
"Candidate": {
"properties": {
"id": {
"description": "Candidate's ID",
"type": "integer",
"example": 111
},
"slug": {
"description": "Candidate's Slug",
"type": "string",
"example": "010011"
},
"first_name": {
"description": "Candidate's First Name",
"type": "string",
"example": "Michael"
},
"last_name": {
"description": "Candidate's Last Name",
"type": "string",
"example": "Scott"
},
"email": {
"description": "Candidate's Valid E-Mail",
"type": "string",
"example": "mscott@gmail.com"
},
"contact_number": {
"description": "Candidate's Contact Number",
"type": "string",
"example": "+1123226666"
},
"avatar": {
"description": "Candidate's Avatar URL",
"type": "string"
},
"gender_id": {
"description": "Candidate's Gender: For Male - 1, Female - 2",
"type": "integer",
"example": 1
},
"qualification_id": {
"description": "Qualifiation of the candidate",
"type": "integer",
"example": 4
},
"specialization": {
"description": "Candidate's Sepcialisation",
"type": "string",
"example": "Computer Science"
},
"work_ex_year": {
"description": "Total experience in years ",
"type": "integer",
"example": 2
},
"candidate_dob": {
"description": "Birth date of the candidate",
"type": "string",
"example": "2000-06-29T05:36:22.000000Z"
},
"profile_update_link_status": {
"description": "Status of Profile Update Request link: For Link Active - 1, Link Expired - 0",
"type": "string",
"example": "0"
},
"profile_update_requested_on": {
"description": "Profile Update Requested On",
"type": "string",
"example": "2021-02-09T10:00:00.000000Z"
},
"profile_updated_on": {
"description": "Profile Updated On",
"type": "string",
"example": "2021-02-10T10:00:00.000000Z"
},
"current_salary": {
"description": "Current salary of the candidate",
"type": "string",
"example": "150000"
},
"salary_expectation": {
"description": "Expected salary of the candidate",
"type": "string",
"example": "180000"
},
"willing_to_relocate": {
"description": "Is the candidate willing to relocate?",
"type": "integer",
"example": 1
},
"current_organization": {
"description": "Last organisation of the candidate",
"type": "string",
"example": ""
},
"current_organization_slug": {
"description": "Company Slug for the Current Organization of the Candidate",
"type": "string",
"example": "1243452990CBB345345"
},
"current_status": {
"description": "Current Employment Status of the candidate",
"type": "string",
"example": "Employed"
},
"notice_period": {
"description": "Notice Period. Default: 0, Max: 999",
"type": "integer",
"example": 60
},
"currency_id": {
"description": "Currency of the candidate",
"type": "integer",
"example": 2
},
"facebook": {
"description": "Facebook Profile URL of the candidate",
"type": "string",
"example": "http://www.facebook.com/michael4"
},
"twitter": {
"description": "Twitter Profile URL of the candidate",
"type": "string",
"example": "http://www.twitter.com/michael4"
},
"linkedin": {
"description": "Linked In Profile URL of the candidate",
"type": "string",
"example": "http://www.linkedin.com/michael4"
},
"github": {
"description": "GitHub Profile URL of the candidate",
"type": "string",
"example": ""
},
"created_on": {
"description": "Created On ",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"updated_on": {
"description": "Updated On ",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"created_by": {
"description": "Created By ",
"type": "integer",
"example": 10001
},
"updated_by": {
"description": "Updated By ",
"type": "integer",
"example": 10001
},
"owner": {
"description": "Owner",
"type": "integer",
"example": 10001
},
"city": {
"description": "City of the candidate",
"type": "string",
"example": "New York"
},
"locality": {
"description": "Locality of the candidate",
"type": "string",
"example": "Manhattan"
},
"state": {
"description": "State of the candidate",
"type": "string",
"example": "New York"
},
"country": {
"description": "Country of the candidate",
"type": "string",
"example": "United States"
},
"postal_code": {
"description": "Postal Code of the candidate",
"type": "string",
"example": "10001"
},
"address": {
"description": "Address of the candidate",
"type": "string",
"example": ""
},
"relevant_experience": {
"description": "Relevant Experience",
"type": "integer",
"example": 2
},
"position": {
"description": "Position/Title of the candidate",
"type": "string",
"example": "Software Developer"
},
"available_from": {
"description": "Available From Date of the candidate",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"salary_type": {
"description": "Type of salary",
"type": "object",
"example": {
"id": 1,
"label": "Monthly Salary"
}
},
"source": {
"description": "Candidate Source",
"type": "string",
"example": "Linkedin"
},
"language_skills": {
"description": "Languages",
"type": "string",
"example": "English(Native/Bilingual Proficiency)"
},
"skill": {
"description": "Comma Separated string of candidate skills",
"type": "string",
"example": "Java,Python"
},
"resume": {
"description": "Candidate's Resume File",
"type": "string",
"example": "Can be Public URL to file"
},
"resource_url": {
"description": "Candidate's Profile Link",
"type": "string"
},
"custom_fields": {
"description": "Array of Custom Fields",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldResponse"
}
]
},
"example": [
{
"field_id": 1,
"value": "Region 1",
"entity_type": "candidate",
"field_name": "Region",
"field_type": "text"
}
]
},
"xing": {
"type": "string",
"description": "Xing Profile URL of the candidate"
},
"candidate_summary": {
"type": "string",
"description": "Summary Of Candidate"
},
"is_email_opted_out": {
"type": "boolean",
"description": "Opt out status",
"example": true
},
"email_opt_out_source": {
"type": "string",
"description": "Opted out source. Manually opted out or Unsubscribed",
"example": "Manually opted out"
}
},
"type": "object"
},
"CandidateNewFields": {
"properties": {
"id": {
"description": "Candidate's ID",
"type": "integer",
"example": 111
},
"slug": {
"description": "Candidate's Slug",
"type": "string",
"example": "010011"
},
"first_name": {
"description": "Candidate's First Name",
"type": "string",
"example": "Michael"
},
"last_name": {
"description": "Candidate's Last Name",
"type": "string",
"example": "Scott"
},
"email": {
"description": "Candidate's Valid E-Mail",
"type": "string",
"example": "mscott@gmail.com"
},
"contact_number": {
"description": "Candidate's Contact Number",
"type": "string",
"example": "+1123226666"
},
"avatar": {
"description": "Candidate's Avatar URL",
"type": "string"
},
"gender_id": {
"description": "Candidate's Gender: For Male - 1, Female - 2",
"type": "integer",
"example": 1
},
"qualification_id": {
"description": "Qualifiation of the candidate",
"type": "integer",
"example": 4
},
"specialization": {
"description": "Candidate's Sepcialisation",
"type": "string",
"example": "Computer Science"
},
"work_ex_year": {
"description": "Total experience in years ",
"type": "integer",
"example": 2
},
"candidate_dob": {
"description": "Birth date of the candidate",
"type": "string",
"example": "2000-06-29T05:36:22.000000Z"
},
"profile_update_link_status": {
"description": "Status of Profile Update Request link: For Link Active - 1, Link Expired - 0",
"type": "string",
"example": "0"
},
"profile_update_requested_on": {
"description": "Profile Update Requested On",
"type": "string",
"example": "2021-02-09T10:00:00.000000Z"
},
"profile_updated_on": {
"description": "Profile Updated On",
"type": "string",
"example": "2021-02-10T10:00:00.000000Z"
},
"current_salary": {
"description": "Current salary of the candidate",
"type": "string",
"example": "150000"
},
"salary_expectation": {
"description": "Expected salary of the candidate",
"type": "string",
"example": "180000"
},
"willing_to_relocate": {
"description": "Is the candidate willing to relocate?",
"type": "integer",
"example": 1
},
"current_organization": {
"description": "Last organisation of the candidate",
"type": "string",
"example": ""
},
"current_organization_slug": {
"description": "Company Slug for the Current Organization of the Candidate",
"type": "string",
"example": "1243452990CBB345345"
},
"current_status": {
"description": "Current Employment Status of the candidate",
"type": "string",
"example": "Employed"
},
"notice_period": {
"description": "Notice Period. Default: 0, Max: 999",
"type": "integer",
"example": 60
},
"currency_id": {
"description": "Currency of the candidate",
"type": "integer",
"example": 2
},
"facebook": {
"description": "Facebook Profile URL of the candidate",
"type": "string",
"example": "http://www.facebook.com/michael4"
},
"twitter": {
"description": "Twitter Profile URL of the candidate",
"type": "string",
"example": "http://www.twitter.com/michael4"
},
"linkedin": {
"description": "Linked In Profile URL of the candidate",
"type": "string",
"example": "http://www.linkedin.com/michael4"
},
"github": {
"description": "GitHub Profile URL of the candidate",
"type": "string",
"example": ""
},
"created_on": {
"description": "Created On ",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"updated_on": {
"description": "Updated On ",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"created_by": {
"description": "Created By ",
"type": "integer",
"example": 10001
},
"updated_by": {
"description": "Updated By ",
"type": "integer",
"example": 10001
},
"owner": {
"description": "Owner",
"type": "integer",
"example": 10001
},
"city": {
"description": "City of the candidate",
"type": "string",
"example": "New York"
},
"locality": {
"description": "Locality of the candidate",
"type": "string",
"example": "Manhattan"
},
"state": {
"description": "State of the candidate",
"type": "string",
"example": "New York"
},
"country": {
"description": "Country of the candidate",
"type": "string",
"example": "United States"
},
"postal_code": {
"description": "Postal Code of the candidate",
"type": "string",
"example": "10001"
},
"address": {
"description": "Address of the candidate",
"type": "string",
"example": ""
},
"relevant_experience": {
"description": "Relevant Experience",
"type": "integer",
"example": 2
},
"position": {
"description": "Position/Title of the candidate",
"type": "string",
"example": "Software Developer"
},
"available_from": {
"description": "Available From Date of the candidate",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"salary_type": {
"description": "Type of salary",
"type": "object",
"example": {
"id": 1,
"label": "Monthly Salary"
}
},
"source": {
"description": "Candidate Source",
"type": "string",
"example": "Linkedin"
},
"language_skills": {
"description": "Languages",
"type": "string",
"example": "English(Native/Bilingual Proficiency)"
},
"skill": {
"description": "Comma Separated string of candidate skills",
"type": "string",
"example": "Java,Python"
},
"resume": {
"description": "Candidate's Resume File",
"type": "string",
"example": "Can be Public URL to file"
},
"resource_url": {
"description": "Candidate's Profile Link",
"type": "string"
},
"custom_fields": {
"description": "Array of Custom Fields",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldResponse"
}
]
},
"example": [
{
"field_id": 1,
"value": "Region 1",
"entity_type": "candidate",
"field_name": "Region",
"field_type": "text"
}
]
},
"xing": {
"type": "string",
"description": "Xing Profile URL of the candidate"
},
"candidate_summary": {
"type": "string",
"description": "Summary Of Candidate"
},
"is_email_opted_out": {
"type": "boolean",
"description": "Opt out status",
"example": true
},
"email_opt_out_source": {
"type": "string",
"description": "Opted out source. Manually opted out or Unsubscribed",
"example": "Manually opted out"
},
"last_calllog_added_on": {
"type": "string",
"description": "Last call log added date",
"example": "2024-06-05T15:15:00.000000Z"
},
"last_calllog_added_by": {
"type": "integer",
"description": "Updated By user details",
"example": 5
},
"last_meeting_created_on": {
"type": "string",
"description": "Last meeting added date",
"example": "2024-06-05T15:15:00.000000Z"
},
"last_meeting_created_by": {
"type": "integer",
"description": "Updated By user details",
"example": 5
},
"last_linkedin_message_sent_on": {
"type": "string",
"description": "Last linkedin message sent on date",
"example": "2024-06-05T15:15:00.000000Z"
},
"last_linkedin_message_sent_by": {
"type": "integer",
"description": "Updated By user details",
"example": 5
},
"last_email_sent_on": {
"type": "string",
"description": "Last email sent on date",
"example": "2024-06-05T15:15:00.000000Z"
},
"last_email_sent_by": {
"type": "integer",
"description": "Updated By user details",
"example": 5
},
"last_sms_sent_on": {
"type": "string",
"description": "Last sms sent on date",
"example": "2024-06-05T15:15:00.000000Z"
},
"last_sms_sent_by": {
"type": "integer",
"description": "Updated By user details",
"example": 5
},
"last_communication": {
"type": "string",
"description": "Last communication method",
"example": "SMS on 2024-06-05 15:15:00"
},
"status_label": {
"type": "string",
"description": "Off Limit Status",
"example": "Unavailable"
},
"off_limit_end_date": {
"type": "string",
"description": "Off Limit End Date",
"example": "2020-06-29T05:36:22.000000Z"
},
"off_limit_reason": {
"type": "string",
"description": "Off Limit Reason",
"example": "testing"
}
},
"type": "object"
},
"CandidateQuestions": {
"properties": {
"id": {
"description": "ID for question",
"type": "integer",
"example": 4
},
"question": {
"description": "Question Text.",
"type": "string"
}
},
"type": "object"
},
"MultipleHiringPipeline": {
"properties": {
"name": {
"description": "Hiring Pipeline Name",
"type": "string",
"example": "Master Hiring Pipeline"
},
"id": {
"description": "Pipeline ID",
"type": "integer",
"example": 0
}
},
"type": "object"
},
"CandidateStatus": {
"properties": {
"stage_id": {
"description": "Stage ID",
"type": "integer",
"example": 56
},
"label": {
"description": "Stage Label",
"type": "string",
"example": "Lead"
}
},
"type": "object"
},
"Company": {
"type": "object",
"properties": {
"id": {
"description": "Company's ID",
"type": "integer",
"example": 2
},
"industry_id": {
"description": "Company's industry ID",
"type": "integer"
},
"company_name": {
"description": "Name of the company",
"type": "string",
"example": "Recruit CRM"
},
"about_company": {
"type": "string",
"maxLength": 5000
},
"logo": {
"description": "Company's Logo URL",
"type": "string"
},
"slug": {
"description": "Company's slug",
"type": "string"
},
"created_on": {
"description": "Created On",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"updated_on": {
"description": "Updated On",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"website": {
"description": "Website URL of the company",
"type": "string",
"example": "https://www.recruitcrm.io"
},
"city": {
"description": "City of the company",
"type": "string",
"example": "New York"
},
"locality": {
"description": "Locality of the company",
"type": "string",
"example": "Manhattan"
},
"state": {
"description": "State of the company",
"type": "string",
"example": "New York"
},
"country": {
"description": "Country of the company",
"type": "string",
"example": "United States"
},
"postal_code": {
"description": "Postal Code of the company",
"type": "string",
"example": "110001"
},
"address": {
"description": "Address of the company",
"type": "string",
"example": ""
},
"facebook": {
"description": "Facebook Profile URL of the company",
"type": "string",
"example": "https://www.facebook.com/recruitcrm.io/"
},
"twitter": {
"description": "Twitter Profile URL of the company",
"type": "string",
"example": "https://www.twitter.com/CrmRecruit/"
},
"linkedin": {
"description": "Linked In Profile URL of the company",
"type": "string",
"example": "https://www.linkedin.com/company/recruitcrm/"
},
"custom_fields": {
"description": "Array of Custom Fields",
"type": "array",
"example": [
{
"field_id": 1,
"value": "Region 1"
}
],
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CustomField"
}
]
}
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "213245"
},
"updated_by": {
"type": "string",
"example": "123443",
"description": "Updated By"
},
"owner": {
"type": "string",
"description": "Owner",
"example": "100023"
},
"resource_url": {
"type": "string",
"description": "Resource Url"
},
"is_child_company": {
"type": "string",
"example": "Yes",
"description": "Whether it is a child company."
},
"is_parent_company": {
"type": "string",
"example": "No",
"description": "Whether it is a parent company."
},
"child_company_slugs": {
"type": "array",
"description": "Array containing all company slugs.",
"items": {
"type": "string",
"example": "17370009412IEv"
}
},
"parent_company_slug": {
"type": "string",
"description": "Parent company slug."
},
"last_meeting_created_on": {
"type": "string",
"description": "Last meeting added date",
"example": "2024-06-05T15:15:00.000000Z"
},
"last_meeting_created_by": {
"type": "integer",
"description": "Updated By user details",
"example": 5
},
"status_label": {
"type": "string",
"description": "Off Limit Status",
"example": "Unavailable"
},
"off_limit_end_date": {
"type": "string",
"description": "Off Limit End Date",
"example": "2020-06-29T05:36:22.000000Z"
},
"off_limit_reason": {
"type": "string",
"description": "Off Limit Reason",
"example": "testing"
}
}
},
"Contact": {
"type": "object",
"properties": {
"id": {
"description": "Contact's ID",
"type": "integer",
"example": 2
},
"first_name": {
"description": "Contact's First Name",
"type": "string",
"example": "Michael"
},
"last_name": {
"description": "Contact's Last Name",
"type": "string",
"example": "Scott"
},
"email": {
"description": "Contact's Valid E-Mail",
"type": "string",
"example": "mscott@gmail.com"
},
"contact_number": {
"description": "Contact's Contact Number",
"type": "string",
"example": "+1123226666"
},
"avatar": {
"description": "Contact's Avatar URL",
"type": "string"
},
"slug": {
"description": "Contact's slug",
"type": "string"
},
"company_slug": {
"description": "Associated company's slug",
"type": "string"
},
"additional_company_slugs": {
"description": "Associated company's slug",
"type": "string"
},
"created_on": {
"description": "Created On",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"updated_on": {
"description": "Updated On",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"stage_id": {
"description": "Contact's stage",
"type": "integer"
},
"facebook": {
"description": "Facebook Profile URL of the contact",
"type": "string",
"example": "http://www.facebook.com/michael4"
},
"twitter": {
"description": "Twitter Profile URL of the contact",
"type": "string",
"example": "http://www.twitter.com/michael4"
},
"linkedin": {
"description": "Linked In Profile URL of the contact",
"type": "string",
"example": "http://www.linkedin.com/michael4"
},
"xing": {
"description": "Xing Profile URL of the contact",
"type": "string",
"example": "http://www.xing.com/xyz"
},
"city": {
"description": "City of the contact",
"type": "string",
"example": "New York"
},
"locality": {
"description": "Locality of the contact",
"type": "string",
"example": "Manhattan"
},
"address": {
"description": "Address of the contact",
"type": "string",
"example": ""
},
"designation": {
"description": "Designation of the contact | This is title field",
"type": "string",
"example": "HR Manager"
},
"custom_fields": {
"description": "Array of Custom Fields",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CustomField"
}
]
},
"example": [
{
"field_id": 1,
"value": "Region 1"
}
]
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "134352"
},
"updated_by": {
"type": "string",
"description": "Updated By",
"example": "243432"
},
"owner": {
"type": "string",
"description": "Owner",
"example": "32434"
},
"resource_url": {
"type": "string",
"description": "Resource Url"
},
"is_email_opted_out": {
"type": "boolean",
"description": "Opt out status",
"example": true
},
"email_opt_out_source": {
"type": "string",
"description": "Opted out source. Manually opted out or Unsubscribed",
"example": "Manually opted out"
}
}
},
"ContactWithNewFields": {
"type": "object",
"properties": {
"id": {
"description": "Contact's ID",
"type": "integer",
"example": 2
},
"first_name": {
"description": "Contact's First Name",
"type": "string",
"example": "Michael"
},
"last_name": {
"description": "Contact's Last Name",
"type": "string",
"example": "Scott"
},
"email": {
"description": "Contact's Valid E-Mail",
"type": "string",
"example": "mscott@gmail.com"
},
"contact_number": {
"description": "Contact's Contact Number",
"type": "string",
"example": "+1123226666"
},
"avatar": {
"description": "Contact's Avatar URL",
"type": "string"
},
"slug": {
"description": "Contact's slug",
"type": "string"
},
"company_slug": {
"description": "Associated company's slug",
"type": "string"
},
"additional_company_slugs": {
"description": "Associated company's slug",
"type": "string"
},
"created_on": {
"description": "Created On",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"updated_on": {
"description": "Updated On",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"stage_id": {
"description": "Contact's stage",
"type": "integer"
},
"facebook": {
"description": "Facebook Profile URL of the contact",
"type": "string",
"example": "http://www.facebook.com/michael4"
},
"twitter": {
"description": "Twitter Profile URL of the contact",
"type": "string",
"example": "http://www.twitter.com/michael4"
},
"linkedin": {
"description": "Linked In Profile URL of the contact",
"type": "string",
"example": "http://www.linkedin.com/michael4"
},
"xing": {
"description": "Xing Profile URL of the contact",
"type": "string",
"example": "http://www.xing.com/xyz"
},
"city": {
"description": "City of the contact",
"type": "string",
"example": "New York"
},
"locality": {
"description": "Locality of the contact",
"type": "string",
"example": "Manhattan"
},
"state": {
"description": "State of the contact",
"type": "string",
"example": "New York"
},
"country": {
"description": "Country of the contact",
"type": "string",
"example": "United States"
},
"postal_code": {
"description": "Postal Code of the contact",
"type": "string",
"example": "110001"
},
"address": {
"description": "Address of the contact",
"type": "string",
"example": ""
},
"designation": {
"description": "Designation of the contact | This is title field",
"type": "string",
"example": "HR Manager"
},
"custom_fields": {
"description": "Array of Custom Fields",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CustomField"
}
]
},
"example": [
{
"field_id": 1,
"value": "Region 1"
}
]
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "134352"
},
"updated_by": {
"type": "string",
"description": "Updated By",
"example": "243432"
},
"owner": {
"type": "string",
"description": "Owner",
"example": "32434"
},
"resource_url": {
"type": "string",
"description": "Resource Url"
},
"is_email_opted_out": {
"type": "boolean",
"description": "Opt out status",
"example": true
},
"email_opt_out_source": {
"type": "string",
"description": "Opted out source. Manually opted out or Unsubscribed",
"example": "Manually opted out"
},
"last_calllog_added_on": {
"type": "string",
"description": "Last call log added date",
"example": "2024-06-05T15:15:00.000000Z"
},
"last_calllog_added_by": {
"type": "integer",
"description": "Updated By user details",
"example": 5
},
"last_meeting_created_on": {
"type": "string",
"description": "Last meeting added date",
"example": "2024-06-05T15:15:00.000000Z"
},
"last_meeting_created_by": {
"type": "integer",
"description": "Updated By user details",
"example": 5
},
"last_linkedin_message_sent_on": {
"type": "string",
"description": "Last linkedin message sent on date",
"example": "2024-06-05T15:15:00.000000Z"
},
"last_linkedin_message_sent_by": {
"type": "integer",
"description": "Updated By user details",
"example": 5
},
"last_email_sent_on": {
"type": "string",
"description": "Last email sent on date",
"example": "2024-06-05T15:15:00.000000Z"
},
"last_email_sent_by": {
"type": "integer",
"description": "Updated By user details",
"example": 5
},
"last_sms_sent_on": {
"type": "string",
"description": "Last sms sent on date",
"example": "2024-06-05T15:15:00.000000Z"
},
"last_sms_sent_by": {
"type": "integer",
"description": "Updated By user details",
"example": 5
},
"last_communication": {
"type": "string",
"description": "Last communication method",
"example": "SMS on 2024-06-05 15:15:00"
},
"status_label": {
"type": "string",
"description": "Off Limit Status",
"example": "Unavailable"
},
"off_limit_end_date": {
"type": "string",
"description": "Off Limit End Date",
"example": "2020-06-29T05:36:22.000000Z"
},
"off_limit_reason": {
"type": "string",
"description": "Off Limit Reason",
"example": "testing"
}
}
},
"ContactStage": {
"properties": {
"stage_id": {
"description": "Stage ID",
"type": "integer",
"example": 56
},
"label": {
"description": "Stage Label",
"type": "string",
"example": "Lead"
}
},
"type": "object"
},
"Currency": {
"properties": {
"currency_id": {
"description": "Currency ID",
"type": "integer",
"example": 2
},
"code": {
"description": "Currency Code",
"type": "string",
"example": "INR"
},
"country": {
"description": "Currency Country",
"type": "string",
"example": "India"
},
"currency": {
"description": "Currency",
"type": "string",
"example": "Rupees"
},
"symbol": {
"description": "Currency symbol",
"type": "string",
"example": "₹"
}
},
"type": "object"
},
"CustomField": {
"properties": {
"field_id": {
"description": "Field ID",
"type": "integer"
},
"value": {
"description": "Custom Value",
"type": "string"
}
},
"type": "object"
},
"Deal": {
"properties": {
"id": {
"description": "Deal ID",
"type": "integer"
},
"name": {
"description": "Deal Name",
"type": "string"
},
"deal_stage": {
"description": "Deal Stage",
"type": "string"
},
"deal_value": {
"description": "Deal Value",
"type": "string"
},
"close_date": {
"description": "Deal Close Date",
"type": "string"
},
"deal_type": {
"description": "Deal Type",
"type": "string"
},
"deal_percentage_value": {
"description": "Weighted Deal Amount",
"type": "string"
},
"slug": {
"description": "Deal's Slug",
"type": "string"
},
"archived": {
"description": "`0` - No, `1` - Yes",
"type": "number",
"example": 0
},
"company_slug": {
"description": "Associated company's slug",
"type": "string"
},
"contact_slugs": {
"description": "Associated contact's slugs",
"type": "string",
"example": "1365,1234"
},
"additional_job_slugs": {
"description": "Associated job's slugs",
"type": "string",
"example": "1769,1122,2211"
},
"additional_candidate_slugs": {
"description": "Associated candidate's slugs",
"type": "string",
"example": "137169,21234,56789"
},
"deal_split": {
"type": "array",
"description": "Deal Split",
"items": {
"type": "object",
"properties": {
"teammates_collaborator": {
"type": "object",
"description": "Teammates collaborator"
},
"teams_collaborator": {
"type": "object",
"description": "Teams collaborator"
},
"teammates_unallocated_split_percentage": {
"type": "string",
"description": "Unallocated split percenatge of teammate"
},
"teams_unallocated_split_percentage": {
"type": "string",
"description": "Unallocated split percenatge of team"
},
"split_type": {
"type": "string",
"description": "Split type of Deal"
}
}
}
},
"custom_fields": {
"description": "Array of Custom Fields",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CustomField"
}
]
},
"example": [
{
"field_id": 1,
"value": "Region 1"
}
]
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2020-06-29T05:36:22.000000Z"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2020-06-29T05:36:22.000000Z"
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "321134"
},
"updated_by": {
"type": "string",
"description": "Updated By",
"example": "122343"
},
"owner": {
"type": "string",
"description": "Owner",
"example": "100012"
},
"resource_url": {
"type": "string",
"description": "Resource Url"
}
},
"type": "object"
},
"DealPipelineStage": {
"properties": {
"id": {
"description": "Deal Stage ID",
"type": "integer",
"example": 3
},
"label": {
"description": "Deal Stage Label",
"type": "string",
"example": "In Progress"
},
"percentage": {
"description": "Deal Stage Percentage",
"type": "string",
"example": "10"
}
},
"type": "object"
},
"DealType": {
"properties": {
"id": {
"description": "Deal Type ID",
"type": "integer",
"example": 2
},
"label": {
"description": "Deal Type Label",
"type": "string",
"example": "Existing Business"
}
},
"type": "object"
},
"Hotlist": {
"properties": {
"id": {
"description": "Hotlist ID",
"type": "integer",
"example": 2
},
"name": {
"description": "Hotlist Name",
"type": "string",
"example": "PHP Developer"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job",
"type": "string",
"example": "candidate"
},
"related": {
"description": "Comma-separated slugs of records added to Hotlist",
"type": "string",
"example": "23123,51233"
},
"shared": {
"description": "Shared with team flag",
"type": "integer",
"example": 1
},
"created_by": {
"description": "Created By",
"type": "integer",
"example": 12221
}
},
"type": "object"
},
"Industry": {
"properties": {
"industry_id": {
"description": "Industry ID",
"type": "integer",
"example": 6
},
"label": {
"description": "Industry Label",
"type": "string",
"example": "Apparel and Fashion"
}
},
"type": "object"
},
"JobAdditional": {
"allOf": [
{
"$ref": "#/components/schemas/Job"
},
{
"properties": {
"company": {
"description": "Object of Company Details",
"type": "object",
"$ref": "#/components/schemas/Company",
"example": {
"id": 1,
"company_name": "Recruit CRM",
"about_company": "recruit-crm"
}
},
"contact": {
"description": "Object of Contact Details",
"type": "object",
"$ref": "#/components/schemas/Contact",
"example": {
"id": 1,
"first_name": "John",
"last_name": "Doe"
}
},
"secondary_contacts": {
"description": "Array of Secondary Contacts",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
]
},
"example": [
{
"id": 1,
"first_name": "John",
"last_name": "Doe"
}
]
},
"currency": {
"description": "Object of Currency Details",
"type": "object",
"$ref": "#/components/schemas/Currency",
"example": {
"currency_id": 1,
"code": "USD",
"country": "United States",
"currency": "Dollar",
"symbol": "$"
}
},
"industry": {
"description": "Object of Industry Details",
"type": "object",
"$ref": "#/components/schemas/Industry",
"example": {
"industry_id": 1,
"label": "Information Technology and Services"
}
}
}
}
]
},
"Job": {
"properties": {
"id": {
"description": "Job's ID",
"type": "integer",
"example": 2
},
"name": {
"description": "Job's Name",
"type": "string",
"example": "ReactJs Developer"
},
"slug": {
"description": "Job's slug",
"type": "string",
"example": "121"
},
"company_slug": {
"description": "Associated company's slug",
"type": "string",
"example": "111"
},
"contact_slug": {
"description": "Associated contact's slug",
"type": "string",
"example": "222"
},
"secondary_contact_slugs": {
"description": "Secondary contact's slug",
"type": "array",
"items": {
"type": "string"
},
"example": [
"333",
"444"
]
},
"note_for_candidates": {
"description": "Note For Candidates",
"type": "string",
"example": "Please bring all original documents"
},
"number_of_openings": {
"description": "Number of openings",
"type": "integer",
"example": 4
},
"minimum_experience": {
"description": "Minimum Experience in Year",
"type": "integer",
"example": 3
},
"maximum_experience": {
"description": "Maximum Experience in Year",
"type": "integer",
"example": 6
},
"min_annual_salary": {
"description": "Minimum Annual Salary",
"type": "integer",
"example": 500000
},
"max_annual_salary": {
"description": "Maximum Annual Salary",
"type": "integer",
"example": 800000
},
"job_status": {
"description": "Object of Job Status Details",
"type": "object",
"items": {
"allOf": {
"$ref": "#/components/schemas/JobStatus"
}
},
"example": {
"id": 1,
"label": "Open"
}
},
"job_status_comment": {
"description": "Comment on job status",
"type": "string"
},
"latitude": {
"description": "Latitude of address",
"type": "string"
},
"longitude": {
"description": "Longitude of address",
"type": "string"
},
"job_skill": {
"description": "Skills associated to the job",
"type": "string",
"example": "Html, Javascript, CSS"
},
"job_type": {
"description": "`1` - Part Time, `2` - Full Time, `3` - Contract, `4` - Contract to Permanent",
"type": "number",
"enum": [
1,
2,
3,
4
],
"example": 1
},
"pay_rate": {
"type": "number"
},
"bill_rate": {
"type": "number"
},
"job_category": {
"description": "Category of the Job",
"type": "string",
"minLength": 1,
"example": "Administration"
},
"city": {
"description": "City of the Job Location",
"type": "string",
"example": "New York"
},
"locality": {
"description": "Locality of the Job Location",
"type": "string",
"example": "Manhattan"
},
"country": {
"description": "Country of the Job Location",
"type": "string",
"example": ""
},
"state": {
"description": "State of the Job Location",
"type": "string",
"example": ""
},
"address": {
"description": "Address of the Job Location",
"type": "string",
"example": ""
},
"enable_job_application_form": {
"description": "Enable Job Application Form",
"type": "integer"
},
"job_code": {
"description": "Unique Job Code",
"type": "string"
},
"show_company_logo": {
"description": "Show Company Logo",
"type": "integer"
},
"specialization": {
"description": "Qualification specialization",
"type": "string"
},
"qualification_id": {
"description": "Qualification ID",
"type": "integer"
},
"job_description_text": {
"description": "Job Description Text",
"type": "string"
},
"job_description_file": {
"description": "Job Description File Details",
"type": "string"
},
"job_location_type": {
"description": "`0` - On-Site, `1` - Remote, `2` - Hybrid",
"type": "number",
"enum": [
"0",
"1",
"2"
],
"example": "1"
},
"postal_code": {
"description": "Postal Code of the job",
"type": "string",
"example": "110001"
},
"currency_id": {
"description": "Currency of the job",
"type": "integer",
"example": 2
},
"job_questions": {
"description": "Array of questions of candidate",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CandidateQuestions"
}
]
},
"example": [
{
"id": 1,
"question": "What is Expected CTC?"
}
]
},
"custom_fields": {
"description": "Array of Custom Fields",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CustomField"
}
]
},
"example": [
{
"field_id": 1,
"value": "Region 1"
}
]
},
"hiring_pipeline_id": {
"description": "Hiring Pipeline Associated With The Job",
"type": "integer",
"example": 1
},
"salary_type": {
"type": "string",
"description": "Salary Type",
"example": "Annual"
},
"job_posting_status": {
"type": "string",
"description": "Job Posting Status"
},
"collaborator_users": {
"description": "Array of user collaborators",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
]
}
},
"collaborator_teams": {
"description": "Array of team collaborators",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Team"
}
]
}
},
"xml_feeds": {
"description": "Array of XML Feeds",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/XMLFeeds"
}
]
}
},
"application_form_url": {
"type": "string",
"description": "Application form Url"
},
"shared_job_image": {
"type": "string",
"description": "Shared Job Image"
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2022-11-02T16:49:29.000000Z"
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "120024"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2022-11-02T16:49:29.000000Z"
},
"updated_by": {
"type": "string",
"description": "Updated By",
"example": "120024"
},
"owner": {
"type": "string",
"description": "Owner",
"example": "13223"
},
"targetcompanies": {
"type": "array",
"description": "Array Of Target Companies",
"items": {
"type": "object",
"minProperties": 2,
"maxProperties": 2,
"properties": {
"name": {
"type": "string",
"example": "Dunder Mifflin"
},
"slug": {
"type": "string",
"example": "321az"
}
}
}
}
},
"type": "object"
},
"JobStatus": {
"properties": {
"id": {
"description": "Stage ID",
"type": "integer",
"example": 56
},
"label": {
"description": "Stage Label",
"type": "string",
"example": "Lead"
}
},
"type": "object"
},
"Language": {
"properties": {
"language_id": {
"description": "Language ID",
"type": "integer",
"example": 38
},
"code": {
"description": "Language Code",
"type": "string",
"example": "en"
},
"language_name": {
"description": "Language Name",
"type": "string",
"example": "English"
}
},
"type": "object"
},
"Meeting": {
"type": "object",
"description": "",
"properties": {
"id": {
"description": "Meeting ID",
"type": "integer",
"example": 2
},
"title": {
"description": "Title of Meeting",
"type": "string",
"example": "Follow up call"
},
"meeting_type": {
"description": "Meeting Type",
"type": "array",
"example": [
{
"id": 1,
"label": "Client Meeting"
}
],
"items": {
"allOf": [
{
"$ref": "#/components/schemas/MeetingType"
}
]
}
},
"description": {
"description": "Meeting Description",
"type": "string",
"example": "Make follow up call for interview"
},
"address": {
"description": "Address of meeting",
"type": "string",
"example": "Video call (https://examplelink)"
},
"reminder": {
"description": "Reminder ID of the Meeting. *IDs 'Mapping: -1 => No Reminder, 0 => 0 Min Before, 15 => 15 Min Before, 30 => 30 Min Before, 60 => 1 Hour Before, 120 => 2 Hours Before, 1440 => 1 Day Before*",
"type": "integer",
"example": 30
},
"start_date": {
"description": "Start Date and time of Meeting",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"end_date": {
"description": "End Date and time of Meeting",
"type": "string",
"example": "2020-06-29T06:36:22.000000Z"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job /deal",
"type": "string",
"example": "candidate"
},
"attendees": {
"description": "Array of attendees",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Attendee"
}
]
}
},
"associated_candidates": {
"type": "array",
"description": "Array of Associated Candidates",
"items": {
"type": "string",
"example": "123"
}
},
"associated_contacts": {
"type": "array",
"description": "Array of Associated Contacts",
"items": {
"type": "string",
"example": "2324"
}
},
"associated_companies": {
"type": "array",
"description": "Array of Associated Companies",
"items": {
"type": "string",
"example": "5435"
}
},
"associated_jobs": {
"type": "array",
"description": "Array of Associated Jobs",
"items": {
"type": "string",
"example": "432"
}
},
"associated_deals": {
"type": "array",
"description": "Array of Associated Deals",
"items": {
"type": "string",
"example": "42432"
}
},
"do_not_send_calendar_invites": {
"type": "boolean",
"description": "Response '1' as value => Do not send calendar invites to attendees and related_to entity, Response '0' as value => Send calendar invites to attendees and related_to entity.(BETA)",
"example": "1"
},
"status": {
"type": "string",
"description": "Status Of Meeting"
},
"reminder_date": {
"type": "string",
"description": "Reminder Date and Time Of Meeting",
"example": "2022-12-02T16:30:00.000000Z"
},
"all_day": {
"type": "integer"
},
"related": {
"type": "object",
"description": "Details Of Related Entity"
},
"owner": {
"type": "string",
"description": "Owner",
"example": "10023"
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2022-12-02T16:59:24.000000Z"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2022-12-02T16:59:24.000000Z"
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "10002"
},
"updated_by": {
"type": "string",
"description": "Updated By",
"example": "10002"
},
"collaborator_users": {
"description": "Array of user collaborators (BETA/Tagging)",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
]
}
},
"collaborator_teams": {
"description": "Array of team collaborators (BETA/Tagging)",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Team"
}
]
}
}
}
},
"Task": {
"type": "object",
"properties": {
"id": {
"description": "Task ID",
"type": "integer",
"example": 2
},
"title": {
"description": "Title of Task",
"type": "string",
"example": "Follow up call"
},
"task_type": {
"description": "Task Type",
"type": "array",
"example": [
{
"id": 1,
"label": "Follow up"
}
],
"items": {
"allOf": [
{
"$ref": "#/components/schemas/TaskType"
}
]
}
},
"description": {
"description": "Task Description",
"type": "string",
"example": "Make follow up call for interview"
},
"reminder": {
"description": "Reminder ID of the task. *IDs 'Mapping: -1 => No Reminder, 0 => 0 Min Before, 15 => 15 Min Before, 30 => 30 Min Before, 60 => 1 Hour Before, 1440 => 1 Day Before*",
"type": "integer",
"example": 30
},
"start_date": {
"description": "Start Date and time of task",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job/ deal",
"type": "string",
"example": "candidate"
},
"associated_candidates": {
"type": "array",
"description": "Array of Associated Candidates",
"items": {
"type": "string",
"example": "123"
}
},
"associated_contacts": {
"type": "array",
"description": "Array of Associated Contacts",
"items": {
"type": "string",
"example": "2324"
}
},
"associated_companies": {
"type": "array",
"description": "Array of Associated Companies",
"items": {
"type": "string",
"example": "5435"
}
},
"associated_jobs": {
"type": "array",
"description": "Array of Associated Jobs",
"items": {
"type": "string",
"example": "432"
}
},
"associated_deals": {
"type": "array",
"description": "Array of Associated Deals",
"items": {
"type": "string",
"example": "42432"
}
},
"related_to_name": {
"type": "string",
"description": "Related To Name"
},
"status": {
"type": "string",
"example": "o",
"description": "Status"
},
"reminder_date": {
"type": "string",
"description": "Reminder Date and time of task",
"example": "2022-12-02T16:30:00.000000Z"
},
"owner": {
"type": "string",
"description": "Owner",
"example": "10002"
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2022-12-02T17:00:00.000000Z"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2022-12-02T17:00:00.000000Z"
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "10022"
},
"updated_by": {
"type": "string",
"description": "Updated By",
"example": "10022"
},
"related": {
"type": "object",
"description": "Details Of Related Entity"
},
"collaborators": {
"description": "Array of collaborators",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Collaborator"
}
]
}
},
"collaborator_users": {
"description": "Array of user collaborators (BETA/Tagging)",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
]
}
},
"collaborator_teams": {
"description": "Array of team collaborators (BETA/Tagging)",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Team"
}
]
}
}
}
},
"CallLog": {
"type": "object",
"properties": {
"id": {
"description": "CallLog ID",
"type": "integer",
"example": 2
},
"call_type": {
"description": "Call Direction: For Outgoing Call - CALL_OUTGOING, Incoming Call - CALL_INCOMING",
"type": "string",
"example": "CALL_OUTGOING"
},
"custom_call_type": {
"description": "Custom Call Type",
"type": "array",
"example": [
{
"id": 2241,
"label": "Follow-Up Call"
}
],
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CallType"
}
]
}
},
"call_started_on": {
"description": "Call Start Date Time",
"type": "string",
"example": "2020-12-01T10:30:00.000000Z"
},
"contact_number": {
"description": "Contact Number",
"type": "string",
"example": "1234432112"
},
"call_notes": {
"description": "Call Notes",
"type": "string",
"example": "Will be open for offer after 2 months"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ contact/ company",
"type": "string",
"example": "candidate"
},
"duration": {
"description": "The Call Duration parameter supports the following formats: 1h 2m 10s, 1hr 20min 30sec, 5:30:50, and total seconds (e.g., 3020). The response will be in seconds.",
"type": "string",
"example": "1h 2m 10s"
},
"associated_candidates": {
"type": "array",
"description": "Array of Associated Candidates",
"items": {
"type": "string",
"example": "123"
}
},
"associated_contacts": {
"type": "array",
"description": "Array of Associated Contacts",
"items": {
"type": "string",
"example": "123"
}
},
"associated_companies": {
"type": "array",
"description": "Array of Associated Companies",
"items": {
"type": "string",
"example": "5435"
}
},
"associated_jobs": {
"type": "array",
"description": "Array of Associated Jobs",
"items": {
"type": "string",
"example": "432"
}
},
"associated_deals": {
"type": "array",
"description": "Array of Associated Deals",
"items": {
"type": "string",
"example": "42432"
}
},
"related": {
"type": "object",
"description": "Details Of Related Entity"
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2022-12-02T17:00:00.000000Z"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2022-12-02T17:00:00.000000Z"
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "100023"
},
"updated_by": {
"type": "string",
"description": "Updated By",
"example": "100023"
},
"collaborator_users": {
"description": "Array of user collaborators (BETA/Tagging)",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
]
}
},
"collaborator_teams": {
"description": "Array of team collaborators (BETA/Tagging)",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Team"
}
]
}
}
}
},
"CallLogWithRecording": {
"type": "object",
"properties": {
"id": {
"description": "CallLog ID",
"type": "integer",
"example": 2
},
"call_type": {
"description": "Call Direction: For Outgoing Call - CALL_OUTGOING, Incoming Call - CALL_INCOMING",
"type": "string",
"example": "CALL_OUTGOING"
},
"custom_call_type": {
"description": "Custom Call Type",
"type": "array",
"example": [
{
"id": 2241,
"label": "Follow-Up Call"
}
],
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CallType"
}
]
}
},
"call_started_on": {
"description": "Call Start Date Time",
"type": "string",
"example": "2020-12-01T10:30:00.000000Z"
},
"contact_number": {
"description": "Contact Number",
"type": "string",
"example": "1234432112"
},
"call_notes": {
"description": "Call Notes",
"type": "string",
"example": "Will be open for offer after 2 months"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ contact/ company",
"type": "string",
"example": "candidate"
},
"duration": {
"description": "The Call Duration parameter supports the following formats: 1h 2m 10s, 1hr 20min 30sec, 5:30:50, and total seconds (e.g., 3020). The response will be in seconds.",
"type": "string",
"example": "1h 2m 10s"
},
"associated_candidates": {
"type": "array",
"description": "Array of Associated Candidates",
"items": {
"type": "string",
"example": "123"
}
},
"associated_contacts": {
"type": "array",
"description": "Array of Associated Contacts",
"items": {
"type": "string",
"example": "123"
}
},
"associated_companies": {
"type": "array",
"description": "Array of Associated Companies",
"items": {
"type": "string",
"example": "5435"
}
},
"associated_jobs": {
"type": "array",
"description": "Array of Associated Jobs",
"items": {
"type": "string",
"example": "432"
}
},
"associated_deals": {
"type": "array",
"description": "Array of Associated Deals",
"items": {
"type": "string",
"example": "42432"
}
},
"related": {
"type": "object",
"description": "Details Of Related Entity"
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2022-12-02T17:00:00.000000Z"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2022-12-02T17:00:00.000000Z"
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "100023"
},
"updated_by": {
"type": "string",
"description": "Updated By",
"example": "100023"
},
"collaborator_users": {
"description": "Array of user collaborators (BETA/Tagging)",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
]
}
},
"collaborator_teams": {
"description": "Array of team collaborators (BETA/Tagging)",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Team"
}
]
}
},
"recording": {
"description": "Recording URL (it will only shown if recording_required param is true and there is recording available else null) and this recording will expire one hour after it is generated.",
"type": "string"
}
}
},
"CallType": {
"properties": {
"id": {
"description": "Call Type ID",
"type": "integer",
"example": 20
},
"label": {
"description": "Call Type Label",
"type": "string",
"example": "Interested"
}
},
"type": "object"
},
"NestedFieldType": {
"properties": {
"field_id": {
"description": "Field ID",
"type": "integer",
"example": 1
},
"field_name": {
"description": "Field Label",
"type": "string",
"example": "Sub Industry"
},
"field_type": {
"description": "Field Type",
"type": "string",
"example": "dropdown"
},
"dependency": {
"description": "Dependency",
"type": "object",
"example": {
"Health Care": "Hospitals, Clinics, Medical Labs"
}
},
"visibility": {
"description": "Visibility",
"type": "object",
"example": []
}
},
"type": "object"
},
"NoteType": {
"properties": {
"id": {
"description": "Note Type ID",
"type": "integer",
"example": 1
},
"label": {
"description": "Note Type Label",
"type": "string",
"example": "To Do"
}
},
"type": "object"
},
"MeetingType": {
"properties": {
"id": {
"description": "Meeting Type ID",
"type": "integer",
"example": 1
},
"label": {
"description": "Meeting Type Label",
"type": "string",
"example": "Client Meeting"
}
}
},
"TaskType": {
"properties": {
"id": {
"description": "Task Type ID",
"type": "integer",
"example": 1
},
"label": {
"description": "Task Type Label",
"type": "string",
"example": "Follow up"
}
}
},
"Qualification": {
"properties": {
"qualification_id": {
"description": "Qualification ID",
"type": "integer",
"example": 3
},
"label": {
"description": "Qualification Label",
"type": "string",
"example": "Associate Degree"
}
},
"type": "object"
},
"AssignedCandidatesList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/AssignedJobCandidate"
}
]
}
}
},
"type": "object"
}
]
},
"AssignedJobCandidate": {
"properties": {
"candidate": {
"$ref": "#/components/schemas/Candidate"
},
"status": {
"description": "Candidate's status",
"type": "object",
"example": {
"status_id": 1,
"label": "Assigned"
}
}
},
"type": "object"
},
"CandidateHistory": {
"properties": {
"job_slug": {
"description": "Job's Slug",
"type": "string",
"example": "16425139068240003902ley"
},
"job_name": {
"description": "Job's Name",
"type": "string",
"example": "IT Specialist Job"
},
"company_slug": {
"description": "Associated company's slug",
"type": "string",
"example": "16425139047270003902lSG"
},
"company_name": {
"description": "Name of the company",
"type": "string",
"example": "Pagac Group Company"
},
"job_status_id": {
"description": "Job Status ID",
"type": "integer",
"example": 1
},
"job_status_label": {
"description": "Job status label",
"type": "string",
"example": "Open"
},
"candidate_status_id": {
"description": "Candidate's status ID",
"type": "integer",
"example": 29306
},
"candidate_status": {
"description": "Candidate's status",
"type": "string",
"example": "Interview Rescheduled"
},
"remark": {
"description": "Remark",
"type": "string",
"example": "Task- Illustrious Deadshot Machine/Audiokinesis"
},
"updated_by": {
"description": "Updated By ",
"type": "integer",
"example": 3902
},
"updated_on": {
"description": "Updated On",
"type": "string",
"example": "2022-01-18T13:52:15.000000Z"
}
},
"type": "object"
},
"CandidateHistoryList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/AssignedJobCandidateLogView"
}
]
}
}
},
"type": "object"
}
]
},
"CandidatesList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Candidate"
}
]
}
}
},
"type": "object"
}
]
},
"CandidatesNewFieldList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CandidateNewFields"
}
]
}
}
},
"type": "object"
}
]
},
"CompaniesList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Company"
}
]
}
}
},
"type": "object"
}
]
},
"ContactsNewFieldList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ContactWithNewFields"
}
]
}
}
},
"type": "object"
}
]
},
"ContactsList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
]
}
}
},
"type": "object"
}
]
},
"DealRequest": {
"properties": {
"name": {
"description": "Deal Name",
"type": "string",
"example": "Close Full Stack Developer (10 Positions)"
},
"deal_stage": {
"description": "Deal Stage",
"type": "number",
"example": 35
},
"deal_value": {
"description": "Deal Value",
"type": "number",
"example": 3956.45
},
"close_date": {
"description": "Deal Close Date",
"type": "string",
"example": "2021-10-22"
},
"deal_type": {
"description": "Deal Type",
"type": "number",
"example": 2
},
"company_slug": {
"description": "Associated company's slug",
"type": "string",
"example": "1369"
},
"contact_slugs": {
"description": "Associated contact's slugs",
"type": "string",
"example": "1365,1234"
},
"job_slug": {
"description": "Associated job's slugs",
"type": "string",
"example": "1769"
},
"candidate_slug": {
"description": "Associated candidate's slugs",
"type": "string",
"example": "137169"
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"deal_split": {
"type": "array",
"description": "Deal Split",
"items": {
"type": "object",
"properties": {
"teammates_collaborator": {
"type": "object",
"description": "Teammates Collaborator",
"properties": {
"teammate_id": {
"type": "integer",
"description": "Teammate/user id"
},
"split_percentage": {
"type": "number",
"description": "Deal Split percentage of teammate."
}
}
},
"teams_collaborator": {
"type": "object",
"description": "Teams Collaborator",
"properties": {
"team_id": {
"type": "integer",
"description": "Team id"
},
"split_percentage": {
"type": "number",
"description": "Deal Split percentage of team"
}
}
},
"split_type": {
"type": "string",
"description": "Split type must be custom/equal"
}
}
}
},
"custom_fields": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"field_id": {
"type": "number"
},
"value": {
"type": "string",
"minLength": 1
}
}
}
}
},
"type": "object",
"required": [
"name",
"deal_stage",
"deal_value",
"close_date",
"deal_type"
]
},
"OffLimitStatus": {
"properties": {
"id": {
"description": "Status ID",
"type": "integer",
"example": 3
},
"status_label": {
"description": "Status Label",
"type": "string",
"example": "Unavailable"
},
"status_colour_id": {
"description": "Status Colour Code",
"type": "string",
"example": "F2"
},
"sequence_no": {
"description": "Sequence No",
"type": "integer",
"example": 1
},
"account_id": {
"description": "Account Id",
"type": "integer",
"example": 5
},
"default": {
"description": "Is Status Default",
"type": "integer",
"example": 1
},
"offlimit_status_colour_id": {
"description": "Status Colour Code",
"type": "string",
"example": "F2"
},
"background_color_hex": {
"description": "Status Background Color",
"type": "string",
"example": "#F3F4F6"
},
"text_color_hex": {
"description": "Status Text Color",
"type": "string",
"example": "686869"
}
},
"type": "object"
},
"MarkOffLimitRequestForCandidate": {
"description": "",
"type": "object",
"properties": {
"candidate_slugs": {
"type": "string",
"minLength": 1,
"example": "141827385522"
},
"status_id": {
"type": "number",
"minLength": 1,
"example": "59"
},
"end_date": {
"type": "string",
"minLength": 1,
"example": "20-09-2024"
},
"reason": {
"type": "string",
"example": "testing"
}
},
"required": [
"candidate_slugs",
"status_id",
"end_date"
]
},
"MarkOffLimitResponseForCandidate": {
"properties": {
"candidate_slug": {
"type": "array",
"description": "Candidate's Slug",
"example": [
"141827385522"
]
},
"status_id": {
"description": "Status Id",
"type": "integer",
"example": 59
},
"end_date": {
"description": "End Date",
"type": "string",
"example": "18-09-2023"
},
"reason": {
"description": "Reason",
"type": "string",
"example": "testing"
},
"remark": {
"description": "Reason",
"type": "string",
"example": "Records Were Updated"
}
},
"type": "object"
},
"MarkAvailableRequestForCandidate": {
"description": "",
"type": "object",
"properties": {
"candidate_slugs": {
"type": "string",
"minLength": 1,
"example": "141827385522"
}
},
"required": [
"candidate_slugs"
]
},
"MarkAvailableResponseForCandidate": {
"properties": {
"candidate_slug": {
"type": "array",
"description": "Candidate's Slug",
"example": [
"141827385522"
]
},
"remark": {
"description": "Reason",
"type": "string",
"example": "Records Were Updated"
}
},
"type": "object"
},
"MarkOffLimitRequestForContact": {
"description": "",
"type": "object",
"properties": {
"contact_slugs": {
"type": "string",
"minLength": 1,
"example": "141827385522"
},
"status_id": {
"type": "number",
"minLength": 1,
"example": "59"
},
"end_date": {
"type": "string",
"minLength": 1,
"example": "20-09-2024"
},
"reason": {
"type": "string",
"example": "testing"
}
},
"required": [
"contact_slugs",
"status_id",
"end_date"
]
},
"MarkOffLimitResponseForContact": {
"properties": {
"contact_slug": {
"type": "array",
"description": "Contacte's Slug",
"example": [
"141827385522"
]
},
"status_id": {
"description": "Status Id",
"type": "integer",
"example": 59
},
"end_date": {
"description": "End Date",
"type": "string",
"example": "18-09-2023"
},
"reason": {
"description": "Reason",
"type": "string",
"example": "testing"
},
"remark": {
"description": "Reason",
"type": "string",
"example": "Records Were Updated"
}
},
"type": "object"
},
"MarkAvailableRequestForContact": {
"description": "",
"type": "object",
"properties": {
"contact_slugs": {
"type": "string",
"minLength": 1,
"example": "141827385522"
}
},
"required": [
"contact_slugs"
]
},
"MarkAvailableResponseForContact": {
"properties": {
"contact_slug": {
"type": "array",
"description": "Contact's Slug",
"example": [
"141827385522"
]
},
"remark": {
"description": "Reason",
"type": "string",
"example": "Records Were Updated"
}
},
"type": "object"
},
"MarkOffLimitRequestForCompanies": {
"description": "",
"type": "object",
"properties": {
"company_slugs": {
"type": "string",
"minLength": 1,
"example": "87984,88825"
},
"status_id": {
"type": "number",
"minLength": 1,
"example": "59"
},
"end_date": {
"type": "string",
"minLength": 1,
"example": "20-09-2024"
},
"reason": {
"type": "string",
"example": "testing"
},
"mark_contact_off_limit": {
"type": "boolean",
"example": true
},
"mark_candidate_off_limit": {
"type": "boolean",
"example": true
}
},
"required": [
"company_slugs",
"status_id",
"end_date",
"mark_contact_off_limit",
"mark_candidate_off_limit"
]
},
"MarkOffLimitResponseForCompanies": {
"properties": {
"company_slugs": {
"type": "array",
"description": "Company Slugs",
"example": [
"87984",
"88825"
]
},
"status_id": {
"description": "Status Id",
"type": "integer",
"example": 59
},
"end_date": {
"description": "End Date",
"type": "string",
"example": "18-09-2023"
},
"reason": {
"description": "Reason",
"type": "string",
"example": "testing"
},
"remark": {
"description": "Reason",
"type": "string",
"example": "Records Were Updated"
}
},
"type": "object"
},
"MarkAvailableRequestForCompany": {
"description": "",
"type": "object",
"properties": {
"company_slugs": {
"type": "string",
"minLength": 1,
"example": "87984,88825"
},
"mark_contact_available": {
"type": "boolean",
"example": true
},
"mark_candidate_available": {
"type": "boolean",
"example": true
}
},
"required": [
"company_slugs",
"mark_contact_off_limit",
"mark_candidate_off_limit"
]
},
"MarkAvailableResponseForCompany": {
"properties": {
"company_slugs": {
"type": "array",
"description": "Company Slugs",
"example": [
"87984,88825"
]
},
"mark_contact_available": {
"type": "boolean",
"example": true
},
"mark_candidate_available": {
"type": "boolean",
"example": true
},
"remark": {
"description": "Reason",
"type": "string",
"example": "Records Were Updated"
}
},
"type": "object"
},
"DealsList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Deal"
}
]
}
}
},
"type": "object"
}
]
},
"ErrorUnauthorized": {
"properties": {
"error": {
"description": "Unauthorized",
"type": "string",
"example": "Unauthorized"
}
},
"type": "object"
},
"HotlistRequest": {
"properties": {
"name": {
"description": "Hotlist Name",
"type": "string",
"example": "PHP Developer"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job",
"type": "string",
"example": "candidate"
},
"shared": {
"description": "Shared with team flag",
"type": "integer",
"example": 1
},
"created_by": {
"type": "integer"
}
},
"type": "object"
},
"HotlistsList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Hotlist"
}
]
}
}
},
"type": "object"
}
]
},
"JobsList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"$ref": "#/components/schemas/ExtraPagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Job"
}
]
}
}
},
"type": "object"
}
]
},
"MeetingsList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Meeting"
}
]
}
}
},
"type": "object"
}
]
},
"MeetingRequest": {
"type": "object",
"properties": {
"title": {
"description": "Title of Meeting",
"type": "string",
"example": "Follow up call"
},
"meeting_type_id": {
"description": "Meeting Type Id",
"type": "integer",
"example": 1
},
"description": {
"description": "Meeting Description",
"type": "string",
"example": "Make follow up call for interview"
},
"address": {
"description": "Address of meeting",
"type": "string",
"example": "Video call (https://examplelink)"
},
"reminder": {
"description": "Reminder ID of the Meeting. *IDs 'Mapping: -1 => No Reminder, 0 => 0 Min Before, 15 => 15 Min Before, 30 => 30 Min Before, 60 => 1 Hour Before, 120 => 2 Hours Before, 1440 => 1 Day Before*",
"type": "integer",
"example": 30
},
"start_date": {
"description": "Start Date and time of Meeting",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"end_date": {
"description": "End Date and time of Meeting",
"type": "string",
"example": "2020-06-29T06:36:22.000000Z"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job /deal",
"type": "string",
"example": "candidate"
},
"attendee_contacts": {
"description": "Comma-Separated Slugs of Contacts attending the meeting",
"type": "string",
"example": "21345,33123"
},
"attendee_candidates": {
"description": "Comma-Separated Slugs of Candidates attending the meeting",
"type": "string",
"example": "2543,65478"
},
"attendee_users": {
"description": "Comma-Separated IDs of Users attending the meeting",
"type": "string",
"example": "29998,23453"
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"associated_candidates": {
"type": "string",
"description": "Comma separated candidate slugs",
"example": "275,16318617835190000051Ond"
},
"associated_companies": {
"type": "string",
"description": "Comma separated company slugs",
"example": "275,16318617835190000051Ond"
},
"associated_contacts": {
"type": "string",
"description": "Comma separated contact slugs",
"example": "275,16318617835190000051Ond"
},
"associated_jobs": {
"type": "string",
"description": "Comma separated job slugs",
"example": "275,16318617835190000051Ond"
},
"associated_deals": {
"type": "string",
"description": "Comma separated deal slugs",
"example": "275,16318617835190000051Ond"
},
"do_not_send_calendar_invites": {
"type": "boolean",
"description": "Providing '1' as value => Do not send calendar invites to attendees and related_to entity, Providing '0' as value => Send calendar invites to attendees and related_to entity.(BETA)",
"example": "1"
},
"collaborator_user_ids": {
"type": "string",
"description": "Comma separated user IDs (BETA/Tagging)",
"example": "11496,11497"
},
"collaborator_team_ids": {
"type": "string",
"description": "Comma separated team IDs (BETA/Tagging)",
"example": "16,17"
},
"enable_auto_populate_teams": {
"type": "boolean",
"description": "Providing '1' as value will include all teams of the user provided in owner_id, if added; otherwise, it will include teams of the account owner, unless explicitly provided in collaborator_team_ids.(BETA/Tagging)",
"example": "1"
}
},
"required": [
"title",
"reminder",
"start_date",
"end_date"
]
},
"EditMeetingRequest": {
"type": "object",
"properties": {
"title": {
"description": "Title of Meeting",
"type": "string",
"example": "Follow up call"
},
"meeting_type_id": {
"description": "Meeting Type Id",
"type": "integer",
"example": 1
},
"description": {
"description": "Meeting Description",
"type": "string",
"example": "Make follow up call for interview"
},
"address": {
"description": "Address of meeting",
"type": "string",
"example": "Video call (https://examplelink)"
},
"reminder": {
"description": "Reminder ID of the Meeting. *IDs 'Mapping: -1 => No Reminder, 0 => 0 Min Before, 15 => 15 Min Before, 30 => 30 Min Before, 60 => 1 Hour Before, 120 => 2 Hours Before, 1440 => 1 Day Before*",
"type": "integer",
"example": 30
},
"start_date": {
"description": "Start Date and time of Meeting",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"end_date": {
"description": "End Date and time of Meeting",
"type": "string",
"example": "2020-06-29T06:36:22.000000Z"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job /deal",
"type": "string",
"example": "candidate"
},
"attendee_contacts": {
"description": "Comma-Separated Slugs of Contacts attending the meeting",
"type": "string",
"example": "21345,33123"
},
"attendee_candidates": {
"description": "Comma-Separated Slugs of Candidates attending the meeting",
"type": "string",
"example": "2543,65478"
},
"attendee_users": {
"description": "Comma-Separated IDs of Users attending the meeting",
"type": "string",
"example": "29998,23453"
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"associated_candidates": {
"type": "string",
"description": "Comma separated candidate slugs",
"example": "275,16318617835190000051Ond"
},
"associated_companies": {
"type": "string",
"description": "Comma separated company slugs",
"example": "275,16318617835190000051Ond"
},
"associated_contacts": {
"type": "string",
"description": "Comma separated contact slugs",
"example": "275,16318617835190000051Ond"
},
"associated_jobs": {
"type": "string",
"description": "Comma separated job slugs",
"example": "275,16318617835190000051Ond"
},
"associated_deals": {
"type": "string",
"description": "Comma separated deal slugs",
"example": "275,16318617835190000051Ond"
},
"do_not_send_calendar_invites": {
"type": "boolean",
"description": "Providing '1' as value => Do not send calendar invites to attendees and related_to entity, Providing '0' as value => Send calendar invites to attendees and related_to entity.(BETA)",
"example": "1"
},
"collaborator_user_ids": {
"type": "string",
"description": "Comma separated user IDs (BETA/Tagging)",
"example": "11496,11497"
},
"collaborator_team_ids": {
"type": "string",
"description": "Comma separated team IDs (BETA/Tagging)",
"example": "16,17"
},
"enable_auto_populate_teams": {
"type": "boolean",
"description": "Providing '1' as value will include all teams of the user provided in owner_id, if added; otherwise, it will include teams of the account owner, unless explicitly provided in collaborator_team_ids.(BETA/Tagging)",
"example": "1"
}
}
},
"TasksList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Task"
}
]
}
}
},
"type": "object"
}
]
},
"TaskRequest": {
"type": "object",
"properties": {
"id": {
"description": "Task ID",
"type": "integer",
"example": 2
},
"title": {
"description": "Title of Task",
"type": "string",
"example": "Follow up call"
},
"task_type_id": {
"description": "Task Type ID",
"type": "integer",
"example": 1
},
"description": {
"description": "Task Description",
"type": "string",
"example": "Make follow up call for interview"
},
"reminder": {
"description": "Reminder ID of the task. *IDs 'Mapping: -1 => No Reminder, 0 => 0 Min Before, 15 => 15 Min Before, 30 => 30 Min Before, 60 => 1 Hour Before, 1440 => 1 Day Before*",
"type": "integer",
"example": 30
},
"start_date": {
"description": "Start Date and time of task",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job/ deal",
"type": "string",
"example": "candidate"
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"associated_candidates": {
"type": "string",
"description": "Comma separated candidate slugs",
"example": "275,16318617835190000051Ond"
},
"associated_companies": {
"type": "string",
"description": "Comma separated company slugs",
"example": "275,16318617835190000051Ond"
},
"associated_contacts": {
"type": "string",
"description": "Comma separated contact slugs",
"example": "275,16318617835190000051Ond"
},
"associated_jobs": {
"type": "string",
"description": "Comma separated job slugs",
"example": "275,16318617835190000051Ond"
},
"associated_deals": {
"type": "string",
"description": "Comma separated deal slugs",
"example": "275,16318617835190000051Ond"
},
"collaborators": {
"description": "Comma separated user IDs",
"type": "string",
"example": "12654"
},
"collaborator_team_ids": {
"type": "string",
"description": "Comma separated team IDs (BETA/Tagging)",
"example": "16,17"
},
"enable_auto_populate_teams": {
"type": "boolean",
"description": "Providing '1' as value will include all teams of the user provided in owner_id, if added; otherwise, it will include teams of the account owner, unless explicitly provided in collaborator_team_ids.(BETA/Tagging)",
"example": "1"
}
},
"required": [
"title",
"reminder",
"start_date"
]
},
"EditTaskRequest": {
"type": "object",
"properties": {
"id": {
"description": "Task ID",
"type": "integer",
"example": 2
},
"title": {
"description": "Title of Task",
"type": "string",
"example": "Follow up call"
},
"task_type_id": {
"description": "Task Type ID",
"type": "integer",
"example": 1
},
"description": {
"description": "Task Description",
"type": "string",
"example": "Make follow up call for interview"
},
"reminder": {
"description": "Reminder ID of the task. *IDs 'Mapping: -1 => No Reminder, 0 => 0 Min Before, 15 => 15 Min Before, 30 => 30 Min Before, 60 => 1 Hour Before, 1440 => 1 Day Before*",
"type": "integer",
"example": 30
},
"start_date": {
"description": "Start Date and time of task",
"type": "string",
"example": "2020-06-29T05:36:22.000000Z"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job/ deal",
"type": "string",
"example": "candidate"
},
"owner_id": {
"type": "integer"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"associated_candidates": {
"type": "string",
"description": "Comma separated candidate slugs",
"example": "275,16318617835190000051Ond"
},
"associated_companies": {
"type": "string",
"description": "Comma separated company slugs",
"example": "275,16318617835190000051Ond"
},
"associated_contacts": {
"type": "string",
"description": "Comma separated contact slugs",
"example": "275,16318617835190000051Ond"
},
"associated_jobs": {
"type": "string",
"description": "Comma separated job slugs",
"example": "275,16318617835190000051Ond"
},
"associated_deals": {
"type": "string",
"description": "Comma separated deal slugs",
"example": "275,16318617835190000051Ond"
},
"collaborators": {
"description": "Comma separated user IDs",
"type": "string",
"example": "12654"
},
"collaborator_team_ids": {
"type": "string",
"description": "Comma separated team IDs (BETA/Tagging)",
"example": "16,17"
},
"enable_auto_populate_teams": {
"type": "boolean",
"description": "Providing '1' as value will include all teams of the user provided in owner_id, if added; otherwise, it will include teams of the account owner, unless explicitly provided in collaborator_team_ids.(BETA/Tagging)",
"example": "1"
}
}
},
"CallLogRequest": {
"type": "object",
"properties": {
"call_type": {
"description": "Call Direction: For Outgoing Call - CALL_OUTGOING, Incoming Call - CALL_INCOMING",
"type": "string",
"example": "CALL_OUTGOING"
},
"custom_call_type_id": {
"description": "Custom Call Type",
"type": "integer",
" example": 2
},
"call_started_on": {
"description": "Call Start Date Time",
"type": "string",
"example": "2020-12-01T10:30:00.000000Z"
},
"contact_number": {
"description": "Contact Number",
"type": "string",
"example": "1234432112"
},
"call_notes": {
"description": "Call Notes",
"type": "string",
"example": "Will be open for offer after 2 months"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ contact/ company",
"type": "string",
"example": "candidate"
},
"duration": {
"description": "The Call Duration parameter supports the following formats: 1h 2m 10s, 1hr 20min 30sec, 5:30:50, and total seconds (e.g., 3020). The response will be in seconds.",
"type": "string",
"example": "1h 2m 10s"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"associated_candidates": {
"type": "string",
"description": "Comma separated candidate slugs",
"example": "1379,15752"
},
"associated_contacts": {
"type": "string",
"description": "Comma separated contact slugs",
"example": "1379,15752"
},
"associated_companies": {
"type": "string",
"description": "Comma separated company slugs",
"example": "275,16318617835190000051Ond"
},
"associated_jobs": {
"type": "string",
"description": "Comma separated job slugs",
"example": "275,16318617835190000051Ond"
},
"associated_deals": {
"type": "string",
"description": "Comma separated deal slugs",
"example": "275,16318617835190000051Ond"
},
"collaborator_user_ids": {
"type": "string",
"description": "Comma separated user IDs (BETA/Tagging)",
"example": "11496,11497"
},
"collaborator_team_ids": {
"type": "string",
"description": "Comma separated team IDs (BETA/Tagging)",
"example": "16,17"
},
"enable_auto_populate_teams": {
"type": "boolean",
"description": "Providing '1' as value will include all teams of the user provided in created_by, if added; otherwise, it will include teams of the account owner, unless explicitly provided in collaborator_team_ids.(BETA/Tagging)",
"example": "1"
}
},
"required": [
"call_type",
"call_started_on"
]
},
"EditCallLogRequest": {
"type": "object",
"properties": {
"call_type": {
"description": "Call Direction: For Outgoing Call - CALL_OUTGOING, Incoming Call - CALL_INCOMING",
"type": "string",
"example": "CALL_OUTGOING"
},
"custom_call_type_id": {
"description": "Custom Call Type",
"type": "integer",
"example": 2
},
"call_started_on": {
"description": "Call Start Date Time",
"type": "string",
"example": "2020-12-01T10:30:00.000000Z"
},
"contact_number": {
"description": "Contact Number",
"type": "string",
"example": "1234432112"
},
"call_notes": {
"description": "Call Notes",
"type": "string",
"example": "Will be open for offer after 2 months"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ contact/ company",
"type": "string",
"example": "candidate"
},
"duration": {
"description": "The Call Duration parameter supports the following formats: 1h 2m 10s, 1hr 20min 30sec, 5:30:50, and total seconds (e.g., 3020). The response will be in seconds.",
"type": "string",
"example": "1h 2m 10s"
},
"created_by": {
"type": "integer"
},
"updated_by": {
"type": "integer"
},
"associated_candidates": {
"type": "string",
"description": "Comma separated candidate slugs",
"example": "1379,15752"
},
"associated_contacts": {
"type": "string",
"description": "Comma separated contact slugs",
"example": "1379,15752"
},
"associated_companies": {
"type": "string",
"description": "Comma separated company slugs",
"example": "275,16318617835190000051Ond"
},
"associated_jobs": {
"type": "string",
"description": "Comma separated job slugs",
"example": "275,16318617835190000051Ond"
},
"associated_deals": {
"type": "string",
"description": "Comma separated deal slugs",
"example": "275,16318617835190000051Ond"
},
"collaborator_user_ids": {
"type": "string",
"description": "Comma separated user IDs (BETA/Tagging)",
"example": "11496,11497"
},
"collaborator_team_ids": {
"type": "string",
"description": "Comma separated team IDs (BETA/Tagging)",
"example": "16,17"
},
"enable_auto_populate_teams": {
"type": "boolean",
"description": "Providing '1' as value will include all teams of the user provided in created_by, if added; otherwise, it will include teams of the account owner, unless explicitly provided in collaborator_team_ids.(BETA/Tagging)",
"example": "1"
}
}
},
"CallLogsList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CallLog"
}
]
}
}
},
"type": "object"
}
]
},
"FileRequest": {
"type": "object",
"properties": {
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job/ deal",
"type": "string",
"example": "candidate"
},
"created_by": {
"type": "integer"
},
"folder": {
"description": "Folder to be created or existing folder in which file should be added",
"type": "string",
"example": "folder1"
},
"files[]": {
"type": [
"array",
"string",
"object"
],
"description": "Can be Public URLs to files, or Files (form-data) | Single file shouldn't exceed 15 MB | The total number of files shouldn't exceed 10, and their combined size should not exceed 32 MB."
}
},
"required": [
"related_to",
"related_to_type",
"files[]"
]
},
"CallRecordingRequest": {
"type": "object",
"properties": {
"call_log_id": {
"description": "Call log ID",
"type": "integer",
"example": "123"
},
"generate_transcript": {
"description": "Generate transcript flag, 1(yes) or 0(no)",
"type": "integer",
"example": "1"
},
"call_recording": {
"type": [
"object"
],
"description": "Can be only Files (form-data) | Recording shouldn't exceed 25 MB | The total number of recordings shouldn't exceed 1 | Accepts only 'mp3','mp4','mpeg','mpga','m4a','wav','webm' formats."
},
"updated_by": {
"description": "ID of the user performing the update",
"type": "string",
"example": "112423"
}
},
"required": [
"call_log_id",
"generate_transcript",
"call_recording"
]
},
"CallRecordingResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The recording upload is in progress. You can check the status by using the following endpoint: https://api.recruitcrm.io/v1/call-logs/get-recording-status/{call_log}."
}
}
},
"File": {
"type": "object",
"properties": {
"file_name": {
"type": "string",
"description": "File Name"
},
"file_link": {
"type": "string",
"description": "File Link"
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "10002"
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2022-12-02T16:53:27.000000Z"
},
"related_to": {
"description": "Associated entity's slug",
"type": "string",
"example": "23123"
},
"related_to_type": {
"description": "Associated entity's Name i.e. candidate/ company/ contact/ job/ deal",
"type": "string",
"example": "candidate"
},
"related": {
"type": "object",
"description": "Details Of Related Entity"
},
"folder": {
"type": "string",
"description": "Folder name",
"example": "folder1"
}
}
},
"CustomFieldResponse": {
"properties": {
"field_id": {
"description": "Field ID",
"type": "integer",
"example": 1
},
"entity_type": {
"description": "Entity Type",
"type": "string",
"example": "candidate"
},
"field_name": {
"description": "Field Name",
"type": "string",
"example": "Hobbies"
},
"field_type": {
"description": "Field Type",
"type": "string",
"example": "text"
},
"default_value": {
"description": "Default Value",
"type": "string"
}
},
"type": "object"
},
"NestedCustomFieldResponse": {
"properties": {
"field_id": {
"description": "Field ID",
"type": "integer",
"example": 1
},
"field_name": {
"description": "Field Name",
"type": "string",
"example": "Industry"
},
"field_type": {
"description": "Field Type",
"type": "string",
"example": "dropdown"
},
"children": {
"description": "Children of the Custom Field",
"type": "array",
"example": [
{
"1": {
"field_id": 7,
"field_name": "Sub Industry",
"field_type": "dropdown",
"dependency": {
"Health Care": "Hospitals, Clinics, Medical Labs"
},
"visibility": [],
"children": []
}
}
],
"items": {
"allOf": [
{
"$ref": "#/components/schemas/NestedFieldType"
}
]
}
}
},
"type": "object"
},
"CustomFieldSearch": {
"properties": {
"custom_fields": {
"description": "Array of Custom Fields",
"type": "array",
"items": {
"properties": {
"field_id": {
"description": "Field ID",
"type": "integer",
"example": 1
},
"filter_type": {
"description": "Filter Type",
"type": "string",
"example": "equals",
"enum": [
"equals",
"not_equals",
"contains",
"not_contains",
"available",
"not_available",
"greater_than",
"less_than",
"yes",
"no"
]
},
"filter_value": {
"description": "Value to Filter",
"type": "string",
"example": "search value"
}
},
"type": "object"
}
}
}
},
"CustomFieldSearchSummary": {
"description": "\n\nList of supported Filter Types:-\n\n| Filter Type | Field Types | Filter Value
Required|\n|:------------------|:---------------------------------------------------------------------------|:------------------------|\n| **equals** | text, longtext, number, date, dropdown, multiselect, email, phonenumber | Yes |\n| **not_equals** | text, longtext, number, date, dropdown, multiselect, email, phonenumber | Yes |\n| **contains** | text, longtext, email, phonenumber | Yes |\n| **not_contains** | text, longtext, email, phonenumber | Yes |\n| **available** | text, longtext, number, date, dropdown, multiselect, email,phonenumber,file| No |\n| **not_available** | text, longtext, number, date, dropdown, multiselect, email,phonenumber,file| No |\n| **greater_than** | number, date | Yes |\n| **less_than** | number, date | Yes |\n| **yes** | checkbox | No |\n| **no** | checkbox | No |"
},
"CustomFieldsList": {
"allOf": [
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CustomFieldResponse"
}
]
}
}
]
},
"NestedFieldsList": {
"allOf": [
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/NestedCustomFieldResponse"
}
]
}
}
]
},
"Pagination": {
"properties": {
"current_page": {
"description": "Current page number",
"type": "integer",
"example": 1
},
"first_page_url": {
"description": "URL of the first page",
"type": "string"
},
"from": {
"description": "Records from page number",
"type": "integer",
"example": 1
},
"next_page_url": {
"description": "URL of the next page",
"type": "string",
"example": "null"
},
"path": {
"description": "URL of the endpoint",
"type": "string"
},
"per_page": {
"description": "Records per page",
"type": "integer",
"example": 25
},
"prev_page_url": {
"description": "URL of the next page",
"type": "string",
"example": "null"
},
"to": {
"description": "Records to page number",
"type": "integer",
"example": 25
}
},
"type": "object"
},
"ExtraPagination": {
"properties": {
"last_page": {
"description": "Last page number",
"type": "integer",
"example": 1
},
"total": {
"description": "Total records",
"type": "integer",
"example": 25
},
"last_page_url": {
"description": "URL of the last page",
"type": "string",
"example": "null"
}
},
"type": "object"
},
"User": {
"properties": {
"id": {
"description": "User ID",
"type": "integer",
"example": 34
},
"first_name": {
"description": "User's First Name",
"type": "string",
"example": "Jane"
},
"last_name": {
"description": "User's Last Name",
"type": "string",
"example": "Scott"
},
"email": {
"description": "User's Email",
"type": "string",
"example": "jane.scott@gmail.com"
},
"contact_number": {
"description": "User's contact_number",
"type": "string"
},
"avatar": {
"description": "User's avatar link",
"type": "string"
}
},
"type": "object"
},
"UserWithTeams": {
"properties": {
"id": {
"description": "User ID",
"type": "integer",
"example": 34
},
"first_name": {
"description": "User's First Name",
"type": "string",
"example": "Jane"
},
"last_name": {
"description": "User's Last Name",
"type": "string",
"example": "Scott"
},
"email": {
"description": "User's Email",
"type": "string",
"example": "jane.scott@gmail.com"
},
"contact_number": {
"description": "User's contact_number",
"type": "string"
},
"city": {
"description": "User's city",
"type": "string"
},
"state": {
"description": "User's state",
"type": "string"
},
"country": {
"description": "User's country",
"type": "string"
},
"role": {
"description": "User's role",
"type": "string"
},
"timezone": {
"description": "User's timezone",
"type": "integer"
},
"currency": {
"description": "User's currency",
"type": "string"
},
"application_language": {
"description": "User's application_language",
"type": "string"
},
"avatar": {
"description": "User's avatar link",
"type": "string"
},
"email_signature_added": {
"description": "User's email signature added",
"type": "string"
},
"two_factor_authentication_enabled": {
"description": "User's two factor authentication enabled",
"type": "boolean"
},
"status": {
"description": "User's status",
"type": "string",
"example": "Active/Deactivate"
},
"teams": {
"type": "array",
"$ref": "#/components/schemas/Team"
}
},
"type": "object"
},
"XMLFeeds": {
"properties": {
"id": {
"description": "Jobboard ID",
"type": "integer",
"example": "1"
},
"type": {
"description": "Type Of Jobboard",
"type": "string",
"example": "custom"
},
"label": {
"description": "Label Of Jobboard",
"type": "string",
"example": "Indeed"
}
}
},
"Team": {
"properties": {
"team_id": {
"description": "Team ID",
"type": "integer",
"example": "16"
},
"team_name": {
"description": "Team Name",
"type": "string",
"example": "team1"
}
}
},
"TeamWithUsers": {
"properties": {
"team_id": {
"description": "Team ID",
"type": "integer",
"example": "16"
},
"team_name": {
"description": "Team Name",
"type": "string",
"example": "team1"
},
"users": {
"type": "array",
"$ref": "#/components/schemas/User"
}
},
"type": "object"
},
"AssignedJobCandidateLogView": {
"properties": {
"status": {
"description": "Candidate's status",
"type": "object",
"properties": {
"status_id": {
"type": "integer",
"example": 1
},
"label": {
"type": "string",
"example": "Assigned"
}
},
"example": {
"status_id": 1,
"label": "Assigned"
}
},
"remark": {
"description": "Remark",
"type": "string",
"example": "Updated"
},
"stage_date": {
"description": "Updated Date",
"type": "string",
"example": "2020-03-25T16:14:28.000000Z"
},
"updated_on": {
"description": "Record Updated Date",
"type": "string",
"example": "2020-03-25T16:14:28.000000Z"
},
"updated_by": {
"description": "Updated by User Details",
"type": "string",
"example": "112423"
}
},
"type": "object"
},
"WorkHistoryRequest": {
"properties": {
"candidate_slug": {
"type": "string",
"description": "Candidate's Slug"
},
"title": {
"type": "string",
"description": "Position",
"example": "Director"
},
"employment_type": {
"type": "integer",
"description": "1: Part Time, 2: Full Time, 3: Contract,4: Self-employed,5: Internship,6: Apprenticeship, \n7: Freelance",
"example": 1
},
"industry_id": {
"type": "integer",
"description": "Industry ID",
"example": 6
},
"salary": {
"type": "number",
"description": "Salary",
"example": 150000
},
"is_currently_working": {
"type": "integer",
"description": "0: No,1: Yes",
"example": 0
},
"work_start_date": {
"type": "integer",
"description": "Work Start Date"
},
"work_end_date": {
"type": "integer",
"description": "Last Working Date"
},
"work_description": {
"type": "string",
"description": "Work Description"
}
},
"required": [
"candidate_slug",
"title"
],
"type": "object"
},
"WorkHistoryEditRequest": {
"properties": {
"title": {
"type": "string",
"description": "Position",
"example": "Director"
},
"employment_type": {
"type": "integer",
"description": "1: Part Time, 2: Full Time, 3: Contract,4: Self-employed,5: Internship,6: Apprenticeship, \n7: Freelance",
"example": 1
},
"industry_id": {
"type": "integer",
"description": "Industry ID",
"example": 6
},
"salary": {
"type": "number",
"description": "Salary",
"example": 150000
},
"is_currently_working": {
"type": "integer",
"description": "0: No,1: Yes",
"example": 0
},
"work_start_date": {
"type": "integer",
"description": "Work Start Date"
},
"work_end_date": {
"type": "integer",
"description": "Last Working Date"
},
"work_description": {
"type": "string",
"description": "Work Description"
}
},
"type": "object"
},
"WorkHistoryResponse": {
"properties": {
"id": {
"type": "integer",
"description": "Work ID"
},
"title": {
"type": "string",
"description": "Position",
"example": "Director"
},
"employment_type": {
"type": "integer",
"description": "1: Part Time, 2: Full Time, 3: Contract,4: Self-employed,5: Internship,6: Apprenticeship, \n7: Freelance",
"example": 1
},
"industry_id": {
"type": "integer",
"description": "Industry ID",
"example": 6
},
"salary": {
"type": "number",
"description": "Salary",
"example": 150000
},
"is_currently_working": {
"type": "integer",
"description": "0: No,1: Yes",
"example": 0
},
"work_start_date": {
"type": "integer",
"description": "Work Start Date",
"example": 1585123200
},
"work_end_date": {
"type": "integer",
"description": "Last Working Date"
},
"work_description": {
"type": "string",
"description": "Work Description",
"example": "Worked as a Director"
},
"candidate_slug": {
"type": "string",
"description": "Candidate's Slug",
"example": "275"
},
"candidate_id": {
"type": "integer",
"description": "Candidate's ID",
"example": 275
},
"is_manually_added": {
"type": "integer",
"description": "Is Manually Added",
"example": 1
},
"work_company_name": {
"type": "string",
"description": "Work Company Name",
"example": "ABC Company"
},
"work_location": {
"type": "string",
"description": "Work Location",
"example": "NY"
},
"created_by": {
"type": "integer",
"description": "ID of Created By User",
"example": 10002
},
"updated_by": {
"type": "integer",
"description": "ID of Updated By User",
"example": 10002
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2022-12-02T16:53:27.000000Z"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2022-12-02T16:53:27.000000Z"
}
},
"type": "object"
},
"EducationHistoryRequest": {
"properties": {
"candidate_slug": {
"type": "string",
"description": "Candidate's Slug"
},
"institute_name": {
"type": "string",
"description": "Institute Name",
"example": "Scott Academy"
},
"educational_qualification": {
"type": "string",
"description": "Educational Qualification",
"example": "Bachelor's Degree"
},
"educational_specialization": {
"type": "string",
"description": "Educational Specialization",
"example": "Computer Science"
},
"grade": {
"type": "string",
"description": "Academic Grade",
"example": "A+"
},
"education_location": {
"type": "string",
"description": "Institute Location",
"example": "NY"
},
"education_start_date": {
"type": "integer",
"description": "Degree Start Date"
},
"education_end_date": {
"type": "integer",
"description": "Degree End Date"
},
"education_description": {
"type": "string",
"description": "Description of Degree"
}
},
"required": [
"candidate_slug",
"institute_name"
],
"type": "object"
},
"EducationHistoryEditRequest": {
"properties": {
"candidate_slug": {
"type": "string",
"description": "Candidate's Slug"
},
"institute_name": {
"type": "string",
"description": "Institute Name",
"example": "Scott Academy"
},
"educational_qualification": {
"type": "string",
"description": "Educational Qualification",
"example": "Bachelor's Degree"
},
"educational_specialization": {
"type": "string",
"description": "Educational Specialization",
"example": "Computer Science"
},
"grade": {
"type": "string",
"description": "Academic Grade",
"example": "A+"
},
"education_location": {
"type": "string",
"description": "Institute Location",
"example": "NY"
},
"education_start_date": {
"type": "integer",
"description": "Degree Start Date"
},
"education_end_date": {
"type": "integer",
"description": "Degree End Date"
},
"education_description": {
"type": "string",
"description": "Description of Degree"
}
},
"type": "object"
},
"EducationHistoryResponse": {
"properties": {
"id": {
"type": "integer",
"description": "Education ID",
"example": 1
},
"institute_name": {
"type": "string",
"description": "Institute Name",
"example": "Scott Academy"
},
"educational_qualification": {
"type": "string",
"description": "Educational Qualification",
"example": "Bachelor's Degree"
},
"educational_specialization": {
"type": "string",
"description": "Educational Specialization",
"example": "Computer Science"
},
"grade": {
"type": "string",
"description": "Academic Grade",
"example": "A+"
},
"education_location": {
"type": "string",
"description": "Institute Location",
"example": "NY"
},
"education_start_date": {
"type": "integer",
"description": "Degree Start Date",
"example": 1585123200
},
"education_end_date": {
"type": "integer",
"description": "Degree End Date",
"example": 1585123200
},
"education_description": {
"type": "string",
"description": "Description of Degree",
"example": "Completed Bachelor's Degree"
},
"candidate_slug": {
"type": "string",
"description": "Candidate's Slug",
"example": "275"
},
"candidate_id": {
"type": "integer",
"description": "Candidate's ID",
"example": 275
},
"created_by": {
"type": "integer",
"description": "ID of Created By User",
"example": 10002
},
"updated_by": {
"type": "integer",
"description": "ID of Updated By User",
"example": 10002
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2022-12-02T16:53:27.000000Z"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2022-12-02T16:53:27.000000Z"
},
"is_manually_added": {
"type": "integer",
"description": "Is Manually Added",
"example": 1
}
},
"type": "object"
},
"CandidateQuestionsAndAnswers": {
"properties": {
"Question ID": {
"type": "number",
"description": "ID of the Question"
},
"Question": {
"type": "string",
"description": "Question"
},
"Answer": {
"type": "string",
"description": "Answer"
},
"Answer ID": {
"type": "number",
"description": "ID of the Answer"
}
},
"type": "object"
},
"CandidateQuestionsAndAnswersRequest": {
"properties": {
"question_answers": {
"type": "array",
"items": {
"properties": {
"question_id": {
"description": "Question ID",
"type": "number",
"example": 1
},
"answer": {
"description": "Answer",
"type": "string",
"example": "I'm from India."
}
}
}
}
},
"type": "object"
},
"CandidateJobQuestionsAndAnswers": {
"properties": {
"Question ID": {
"type": "number",
"description": "ID of the Question"
},
"Question": {
"type": "string",
"description": "Question"
},
"Answer": {
"type": "string",
"description": "Answer"
},
"Answer ID": {
"type": "number",
"description": "ID of the Answer"
}
},
"type": "object"
},
"PitchStages": {
"title": "PitchStages",
"type": "object",
"properties": {
"status_id": {
"type": "integer",
"description": "Pitch Status Id",
"example": 1
},
"label": {
"type": "string",
"description": "Stage Label",
"example": "Pitched"
}
}
},
"JobAssociatedFields": {
"properties": {
"associated_fields": {
"type": "array",
"items": {
"properties": {
"field_id": {
"description": "Field ID",
"type": "number",
"example": 1
},
"value": {
"description": "Value for the Field",
"type": "string",
"example": "I'm from India."
}
}
}
}
},
"type": "object"
},
"PitchToContact": {
"title": "PitchToContact",
"type": "object",
"properties": {
"candidate_slug": {
"type": "string",
"description": "Candidate's Slug",
"example": "9716881141193400000005acO"
},
"contact_slug": {
"type": "string",
"description": "Contact's Slug",
"example": "16850938893970000005dqm"
},
"status_id": {
"type": "integer",
"description": "Pitch Status Id",
"example": 6
},
"status_label": {
"type": "string",
"description": "Pitch Status Label",
"example": "Custom stage"
},
"stage_date": {
"type": "string",
"description": "Stage Date",
"example": "2020-03-25T16:14:28.000000Z"
},
"remark": {
"type": "string",
"description": "Remark",
"example": "Marked as Pitched"
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2020-03-28T16:14:28.000000Z"
},
"created_by": {
"type": "integer",
"description": "Created By",
"example": 5
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2020-03-28T16:14:28.000000Z"
},
"updated_by": {
"type": "integer",
"description": "Updated By",
"example": 5
}
}
},
"PitchCandidateHistory": {
"title": "PitchCandidateHistory",
"type": "object",
"properties": {
"contact_slug": {
"type": "string",
"description": "Contact's Slug\n",
"example": "16490671235850000005LSk"
},
"status_id": {
"type": "integer",
"description": "Pitched Status Id",
"example": 1
},
"candidate_status": {
"type": "string",
"description": "Candidate Status label",
"example": "Pitched"
},
"remark": {
"type": "string",
"description": "Remark\n",
"example": "It is marked as pitched"
},
"stage_date": {
"type": "integer",
"description": "Stage Date\n",
"example": "2023-06-29T05:36:22.000000Z"
},
"updated_by": {
"type": "integer",
"description": "Updated By",
"example": 5
},
"created_on": {
"type": "integer",
"description": "Created On",
"example": "2023-06-29T05:36:22.000000Z"
},
"updated_on": {
"type": "integer",
"description": "Updated On",
"example": "2023-06-29T05:36:22.000000Z"
}
}
},
"PitchContactHistory": {
"title": "PitchContactHistory",
"type": "object",
"properties": {
"candidate_slug": {
"type": "string",
"description": "Candidate's Slug\n",
"example": "18390671235850000005LSk"
},
"status_id": {
"type": "integer",
"description": "Pitched Status Id",
"example": 1
},
"candidate_status": {
"type": "string",
"description": "Candidate Status label",
"example": "Pitched"
},
"remark": {
"type": "string",
"description": "Remark\n",
"example": "It is marked as pitched"
},
"stage_date": {
"type": "integer",
"description": "Stage Date\n",
"example": "2023-06-29T05:36:22.000000Z"
},
"updated_by": {
"type": "integer",
"description": "Updated By",
"example": 5
},
"created_on": {
"type": "integer",
"description": "Created On",
"example": "2023-06-29T05:36:22.000000Z"
},
"updated_on": {
"type": "integer",
"description": "Updated On",
"example": "2023-06-29T05:36:22.000000Z"
}
}
},
"UpdatePitchStageResponse": {
"title": "UpdatePitchStageResponse",
"type": "object",
"properties": {
"candidate_slug": {
"type": "string"
},
"contact_slug": {
"type": "string"
},
"status_id": {
"type": "integer"
},
"status_label": {
"type": "string"
},
"stage_date": {
"type": "string"
},
"remark": {
"type": "string"
},
"created_on": {
"type": "string"
},
"created_by": {
"type": "integer"
},
"updated_on": {
"type": "string"
},
"updated_by": {
"type": "integer"
}
}
},
"PitchHistory": {
"title": "PitchHistory",
"type": "object",
"properties": {
"status_id": {
"type": "number",
"description": "Pitch Status Id",
"example": 10
},
"candidate_status": {
"type": "string",
"description": "Pitch Status label",
"example": "custom"
},
"remark": {
"type": "string",
"description": "Remark",
"example": "Pitch History"
},
"stage_date": {
"type": "string",
"description": "Stage Date",
"example": "2023-12-28T17:56:37.000000Z"
},
"updated_by": {
"type": "number",
"description": "Updated By",
"example": "5"
},
"created_on": {
"type": "string",
"description": "Created On",
"example": "2023-12-28T17:56:37.000000Z"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2023-12-28T17:56:37.000000Z"
}
}
},
"PitchCandidateData": {
"title": "PitchCandidateData",
"type": "object",
"properties": {
"candidate_slug": {
"type": "string",
"description": "Candidate's Slug",
"example": "16448144215000000005eFC"
},
"contact_slug": {
"type": "string",
"description": "Contact's Slug",
"example": "16739479639090000005Vsm"
},
"stage_date": {
"type": "string",
"description": "Stage Date",
"example": "2023-12-15T15:26:45.000000Z"
},
"status_id": {
"type": "integer",
"description": "Pitch Status Id",
"example": 1
},
"candidate_status": {
"type": "string",
"description": "Pitch Status Label",
"example": "Pitched"
},
"remark": {
"type": "string",
"description": "Remark",
"example": "Remark addded"
},
"contact_title": {
"type": "string",
"description": "Contact's Title"
},
"contact_profile_pic": {
"type": "string",
"description": "Contact's Profile Pic"
},
"contact_name": {
"type": "string",
"description": "Contact Name",
"example": "Nicole"
},
"contact_email": {
"type": "string",
"description": "Contact Email",
"example": "nicole@gmail.com"
},
"contact_number": {
"type": "integer",
"description": "Contact Number",
"example": "7891781919"
},
"candidate_profile_pic": {
"type": "string",
"description": "Candidate's Profile Pic"
},
"candidate_name": {
"type": "string",
"description": "Candidate's Name",
"example": "Wyn Mattheis"
},
"candidate_email": {
"type": "string",
"description": "Candidate's Email",
"example": "wyn@testmail.com"
},
"candidate_contact_number": {
"type": "integer",
"description": "Candidate's Contact Number",
"example": 62819910101
},
"resume": {
"type": "string",
"description": "Resume"
},
"candidate_position": {
"type": "string",
"description": "Candidate's Position",
"example": "Development team lead"
},
"created_by": {
"type": "string",
"description": "Created By",
"example": "5"
},
"created_on": {
"type": "string",
"description": "Created on",
"example": "2023-12-15T15:26:45.000000Z"
},
"updated_by": {
"type": "string",
"description": "Updated By",
"example": "1001"
},
"updated_on": {
"type": "string",
"description": "Updated On",
"example": "2023-12-15T15:26:45.000000Z"
},
"resume_file_name": {
"type": "string",
"description": "Resume File name"
},
"candidate_email_opt_out": {
"type": "boolean",
"description": "Candidate email opt out",
"example": "0"
},
"contact_email_opt_out": {
"type": "boolean",
"description": "Contact email opt out",
"example": "0"
}
}
},
"UpdatePitchStageRequest": {
"type": "object",
"title": "UpdatePitchStageRequest",
"properties": {
"status_id": {
"type": "integer",
"description": "Pitch Status Id",
"example": 6
},
"stage_date": {
"type": "string",
"description": "Stage Date",
"example": "2020-03-25T16:14:28.000000Z"
},
"remark": {
"type": "string",
"description": "Remark",
"example": "Updated Pitch stage"
}
},
"required": [
"status_id"
]
},
"TargetReportList": {
"properties": {
"TargetId": {
"type": "number",
"description": "ID of the Target Report"
},
"TargetName": {
"type": "string",
"description": "Title of the Target Report"
},
"CreatedOn": {
"type": "string",
"description": "Target Report Created Date"
},
"CreatedBy": {
"type": "number",
"description": "Target Report Owner Id "
},
"StartDate": {
"type": "string",
"description": "Target Report Start Date "
},
"EndDate": {
"type": "string",
"description": "Target Report End Date "
},
"Frequency": {
"type": "string",
"description": "Target Report Frequency "
},
"TypeOfAssignees": {
"type": "string",
"description": "Target Report Assignee Type "
},
"Assignees": {
"type": "string",
"description": "Target Report Assignees Ids "
},
"TargetKPIs": {
"type": "string",
"description": "Target Report Kpis"
}
},
"type": "object"
},
"OffLimitHistoryList": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/OffLimitHistory"
}
]
}
}
},
"type": "object"
}
]
},
"OffLimitHistory": {
"title": "OffLimitHistory",
"type": "object",
"properties": {
"status_label": {
"type": "string",
"description": "Off Limit Status",
"example": "Unavailable"
},
"reason": {
"type": "string",
"description": "Off Limit Reason",
"example": "testing"
},
"end_date": {
"type": "string",
"description": "Off Limit End Date",
"example": "2025-12-28T17:56:37.000000Z"
},
"updated_on": {
"type": "string",
"description": "Off Limit Status Updated On",
"example": "2023-12-28T17:56:37.000000Z"
}
}
},
"DraftRequest": {
"type": "object",
"x-stoplight": {
"id": "pjk1rxn3efjrd"
},
"description": "Request Schema ",
"required": [
"to",
"subject"
],
"properties": {
"from": {
"description": "ID of the user associated with the account",
"type": "integer",
"example": 5
},
"to": {
"description": "Details of the primary recipient. Includes:- Type: candidate, contact or user.
- Identifier: Slug for candidate/contact or ID for user.
\n",
"type": "object",
"uniqueItems": true,
"example": {
"type": "candidate",
"identifier": "16705746963230000005xEH"
}
},
"cc": {
"description": "List of CC recipients. Each recipient includes:- Type: candidate, contact or user.
- Identifier: Slug for candidate/contact or ID for user.
- Maximum of 10 recipients
",
"type": "array",
"example": [
{
"type": "contact",
"identifier": "16705746963230000005xEH"
}
],
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "contact"
},
"identifier": {
"type": "string",
"example": "16705746963230000005xEH"
}
}
}
},
"bcc": {
"description": "List of BCC recipients. Each recipient includes:- Type: candidate, contact or user.
- Identifier: Slug for candidate/contact or ID for user.
- Maximum of 10 recipients
",
"type": "array",
"example": [
{
"type": "user",
"identifier": "5"
}
],
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "user"
},
"identifier": {
"type": "string",
"example": "5"
}
}
}
},
"associations": {
"description": "List of Associated recipients. Each recipient includes:- Type: candidate, contact, company, job or deal.
- Identifier: Slug for candidate/contact/company/job/deal.
",
"type": "array",
"example": [
{
"type": "company",
"identifier": "16705746963230000005xEH"
}
],
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "company"
},
"identifier": {
"type": "string",
"example": "16705746963230000005xEH"
}
}
}
},
"subject": {
"description": "Email subject line.",
"type": "string",
"example": "Grow Your Career Today"
},
"body": {
"description": "Email body content.",
"type": "string",
"example": "Are you looking for a new challenge in your career?"
},
"attachments[]": {
"description": "Requirements:- Only public files are allowed.
- Single files must not exceed the size limit set by the provider.
- Total combined size must not exceed the provider's limit.
- Maximum of 5 files are allowed.
",
"type": "array"
},
"include_signature": {
"type": "boolean",
"default": false,
"description": "Should Include E-Mail Signature In Body"
},
"include_opt_out_link": {
"type": "boolean",
"default": false,
"description": "Should Include opt-out/unsubscribe link in Body"
}
}
},
"Draft": {
"type": "object",
"x-stoplight": {
"id": "lfxx50affot62"
},
"properties": {
"message": {
"type": "string",
"example": "We are currently processing your request"
},
"draft_status_id": {
"type": "integer",
"description": "Id to check Status Of Draft Created\n",
"example": 1
},
"status": {
"type": "string",
"example": "success"
}
}
},
"Draft-Success": {
"type": "object",
"x-stoplight": {
"id": "dh7amzbe76llb"
},
"title": "Draft Status - Suceess",
"description": "Success ",
"properties": {
"message": {
"type": "string",
"example": "Draft saved successfully"
},
"created_at": {
"type": "string",
"x-stoplight": {
"id": "o12ejgsfklnb0"
},
"example": "2025-02-14T10:59:00.000000Z"
},
"status": {
"type": "string",
"example": "Success"
},
"draft_id": {
"type": "string",
"x-stoplight": {
"id": "1ussvlsskn3yr"
},
"example": "1"
}
}
},
"Draft-Processing": {
"type": "object",
"x-stoplight": {
"id": "2hjkd95l2352b"
},
"title": "Draft Status - Processing",
"description": "Processing",
"properties": {
"message": {
"type": "string",
"example": "Draft is currently under process"
},
"created_at": {
"type": "string",
"example": "2025-02-14T10:59:00.000000Z"
},
"status": {
"type": "string",
"example": "Processing"
},
"draft_id": {
"type": "string",
"default": "null"
}
}
},
"Draft-Failed": {
"type": "object",
"x-stoplight": {
"id": "4ybtbef27u82h"
},
"title": "Draft Status - Failed",
"description": "Failed",
"properties": {
"message": {
"type": "string",
"example": "There was error creating draft"
},
"created_at": {
"type": "string",
"example": "2025-02-14T10:59:00.000000Z"
},
"status": {
"type": "string",
"example": "Failed"
},
"draft_id": {
"type": "string",
"default": "null"
},
"error_message": {
"x-stoplight": {
"id": "62tq2frju7jss"
},
"anyOf": [
{
"type": "object",
"properties": {
"to": {
"type": "array",
"items": {
"type": "string",
"example": "contact with slug:17126060547340057922hnG doesn't exist,candidate with slug:16797403538710000005FZQ is missing an email address,user with ID:1312313 doesn't exist,candidate with slug:16797403538710000005FZQ is marked as off limit,candidate with slug:16797403538710000005FZQ is opted out of email communication"
}
},
"cc": {
"type": "array",
"items": {
"type": "string",
"example": "contact with slug:17126060547340057922hnG doesn't exist,candidate with slug:16797403538710000005FZQ is missing an email address,user with ID:1312313 doesn't exist,candidate with slug:16797403538710000005FZQ is marked as off limit,candidate with slug:16797403538710000005FZQ is opted out of email communication"
}
},
"bcc": {
"type": "array",
"items": {
"type": "string",
"example": "contact with slug:17126060547340057922hnG doesn't exist,candidate with slug:16797403538710000005FZQ is missing an email address,user with ID:1312313 doesn't exist,candidate with slug:16797403538710000005FZQ is marked as off limit,candidate with slug:16797403538710000005FZQ is opted out of email communication"
}
}
}
},
{
"type": "array",
"items": {
"type": "string",
"example": "Something Went Wrong :("
}
}
]
}
}
},
"Email": {
"title": "Email",
"x-stoplight": {
"id": "yho60mgj9szen"
},
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "We are currently processing your request"
},
"email_status_id": {
"type": "integer",
"description": "Id to check Status Of Email Sent\n",
"example": 1
},
"status": {
"type": "string",
"example": "success"
}
}
},
"Email-Success": {
"x-stoplight": {
"id": "xvhkff2mdwl7v"
},
"type": "object",
"title": "Sent Email Status - Suceess",
"description": "Success",
"properties": {
"message": {
"type": "string",
"example": "Email sent successfully"
},
"created_at": {
"type": "string",
"example": "2025-02-14T10:59:00.000000Z"
},
"status": {
"type": "string",
"example": "Success"
},
"email_message_id": {
"type": "string",
"example": "1"
}
}
},
"Email-Processing": {
"title": "Sent Email Status - Processing",
"x-stoplight": {
"id": "0bz0t6xr5bqgu"
},
"type": "object",
"description": "Processing",
"properties": {
"message": {
"type": "string",
"example": "Sending Email is currently under process"
},
"created_at": {
"type": "string",
"example": "2025-02-14T10:59:00.000000Z"
},
"status": {
"type": "string",
"example": "Processing"
},
"email_message_id": {
"type": "string",
"default": "null"
}
}
},
"Email-Failed": {
"x-stoplight": {
"id": "4122nkais7qj0"
},
"type": "object",
"title": "Sent Email Status - Failed",
"description": "Failed",
"properties": {
"message": {
"type": "string",
"example": "There was an error while sending email"
},
"created_at": {
"type": "string",
"example": "2025-02-14T10:59:00.000000Z"
},
"status": {
"type": "string",
"example": "Failed"
},
"email_message_id": {
"type": "string",
"default": "null"
},
"error_message": {
"anyOf": [
{
"type": "object",
"properties": {
"to": {
"type": "array",
"items": {
"type": "string",
"example": "contact with slug:17126060547340057922hnG doesn't exist,candidate with slug:16797403538710000005FZQ is missing an email address,user with ID:1312313 doesn't exist,candidate with slug:16797403538710000005FZQ is marked as off limit,candidate with slug:16797403538710000005FZQ is opted out of email communication"
}
},
"cc": {
"type": "array",
"items": {
"type": "string",
"example": "contact with slug:17126060547340057922hnG doesn't exist,candidate with slug:16797403538710000005FZQ is missing an email address,user with ID:1312313 doesn't exist,candidate with slug:16797403538710000005FZQ is marked as off limit,candidate with slug:16797403538710000005FZQ is opted out of email communication"
}
},
"bcc": {
"type": "array",
"items": {
"type": "string",
"example": "contact with slug:17126060547340057922hnG doesn't exist,candidate with slug:16797403538710000005FZQ is missing an email address,user with ID:1312313 doesn't exist,candidate with slug:16797403538710000005FZQ is marked as off limit,candidate with slug:16797403538710000005FZQ is opted out of email communication"
}
}
}
},
{
"type": "array",
"items": {
"type": "string",
"example": "Something Went Wrong :("
}
}
]
}
}
}
},
"securitySchemes": {
"global": {
"type": "http",
"scheme": "bearer"
}
},
"examples": {
"Contact": {
"value": {
"first_name": "Ryan",
"last_name": "Cooper",
"email": "ryan.cooper@example.com",
"contact_number": "+1233345",
"company_slug": "16601029339250000005ONm,16600418761900000005jtE",
"avatar": "",
"city": "New York",
"locality": "",
"address": "",
"designation": "HR Manager",
"facebook": "https://www.facebook.com/ryan",
"twitter": "",
"linkedin": "",
"stage_id": 23,
"custom_fields": [
{
"field_id": 1,
"value": "AC-9"
}
]
}
},
"Deal": {
"value": {
"name": "Close Full Stack Developer (10 Positions)",
"deal_stage": 35,
"deal_value": 390000,
"close_date": "2000-06-29T05:36:22.000000Z",
"deal_type": 1,
"deal_percentage_value": "40000",
"company_slug": "1369",
"contact_slugs": "13691,76890",
"job_slug": "11321,432123,555643",
"candidate_slug": "980098,554632",
"deal_split": {
"teammates_collaborator": [
{
"teammate_id": 5,
"split_percentage": 43.98
},
{
"teammate_id": 8,
"split_percentage": 29.76
}
],
"teams_collaborator": [
{
"team_id": 16,
"split_percentage": 6.33
},
{
"team_id": 17,
"split_percentage": 42.89
}
],
"split_type": "custom"
},
"custom_fields": [
{
"field_id": 3,
"value": "ACC-2"
}
]
}
},
"WorkHistoryExample": {
"value": [
{
"candidate_slug": "1234567750000",
"title": "Software Developer",
"work_company_name": "Recruit CRM",
"employment_type": 2,
"industry_id": 3,
"work_location": "New York",
"salary": 150090,
"is_currently_working": 0,
"work_start_date": 1603684640,
"work_end_date": 1603684678,
"work_description": "Supervised a team of 9 employees in all technical and creative aspects of digital advertising campaigns with budgets over $300,000."
}
]
},
"WorkHistoryEditExample": {
"value": {
"title": "Software Developer",
"work_company_name": "Recruit CRM",
"employment_type": 2,
"industry_id": 3,
"work_location": "New York",
"salary": 150090,
"is_currently_working": 0,
"work_start_date": 1603684640,
"work_end_date": 1603684678,
"work_description": "Supervised a team of 9 employees in all technical and creative aspects of digital advertising campaigns with budgets over $300,000."
}
},
"EducationHistoryExample": {
"value": [
{
"candidate_slug": "1234567750000",
"institute_name": "Scott Academy",
"educational_qualification": "Bachelor's Degree",
"educational_specialization": "Computer Science",
"grade": "A+",
"education_location": "NY",
"education_start_date": 1283711400,
"education_end_date": 1365445800,
"education_description": "Engineering Degree in Computer Science"
}
]
},
"EducationHistoryEditExample": {
"value": {
"institute_name": "Scott Academy",
"educational_qualification": "Bachelor's Degree",
"educational_specialization": "Computer Science",
"grade": "A+",
"education_location": "NY",
"education_start_date": 1283711400,
"education_end_date": 1365445800,
"education_description": "Engineering Degree in Computer Science"
}
},
"DraftExample": {
"value": {
"from": 5,
"to": {
"identifier": "1706447729250000005yTn",
"type": "candidate"
},
"cc": [
{
"identifier": "1706447729250000005yTn",
"type": "contact"
}
],
"bcc": [
{
"identifier": "5",
"type": "user"
}
],
"associations": [
{
"identifier": "1706447729250000005yTn",
"type": "company"
}
],
"attachments[]": [],
"body": "",
"subject": "Grow Your Career Today",
"include_signature": false,
"include_opt_out_link": false
}
}
}
},
"security": [
{
"global": []
}
],
"tags": [
{
"name": "Candidates",
"description": "Candidates operations"
},
{
"name": "Contacts",
"description": "Contacts operations"
},
{
"name": "Companies",
"description": "Companies operations"
},
{
"name": "Jobs",
"description": "Jobs operations"
},
{
"name": "Deals",
"description": "Deals operations"
},
{
"name": "Tasks",
"description": "Tasks operations"
},
{
"name": "Meetings",
"description": "Meetings operations"
},
{
"name": "Notes",
"description": "Notes operations"
},
{
"name": "Call Logs",
"description": "Call Logs operations"
},
{
"name": "Hotlists",
"description": "Hotlists operations"
},
{
"name": "Custom Fields",
"description": "Custom Fields operations"
},
{
"name": "Webhook Subscriptions",
"description": "Subscriptions operations"
},
{
"name": "Sequences",
"description": "Sequences operations"
}
],
"servers": [
{
"url": "https://api.recruitcrm.io",
"description": "Prod"
}
]
}