{"components":{"schemas":{}},"info":{"description":"All requests to any Recruiterflow API must include the RF-Api-Key header. Unless otherwise specified, all data is in JSON. Domain for all API requests should be api.recruiterflow.com","termsOfService":"","title":"Recruiterflow API Documentation","version":"0.0.1"},"openapi":"3.0.0","paths":{"/api/external/activity-fetch":{"post":{"description":"**The below table describes the required input**\n\n|

Params

|

Data Type

|

Required

|\n| ------------------- | ------------------ | ----------------- |\n| activity_ids | array | True |\n\n**Sample Payload**\n```\n{\n \"activity_ids\": [1, 2, 3]\n}\n```\n","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"activity_ids":{"description":"list of activity ids whose details are to be fetched.","example":[1,2,3],"items":{"type":"integer"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":"{\n \"data\": [\n {\n \"activity_id\": 20,\n \"associated_entities\": [\n {\n \"entity_status_id\": null,\n \"id\": 31,\n \"img_link\": \"https://com-recruiterflow-dev-setup-content.s3.eu-central-1.amazonaws.com/img/candidates/hal_jordan.jpeg\",\n \"name\": \"Hal Jordan\",\n \"type\": 1\n },\n {\n \"id\": 2,\n \"img_link\": null,\n \"name\": \"test\",\n \"type\": 3\n },\n {\n \"id\": 1,\n \"img_link\": null,\n \"name\": \"Avenger\",\n \"type\": 4\n }\n ],\n \"is_custom\": 1,\n \"subject\": \"test custom activity\",\n \"text\": \"
 test activity1234
\",\n \"time\": \"2025-11-07T10:11:00+0000\",\n \"type\": {\n \"id\": 1000,\n \"name\": \"test custom activity\"\n },\n \"user\": {\n \"email\": \"birendra@recruiterflow.com\",\n \"first_name\": \"Birendra\",\n \"id\": 1,\n \"img_link\": null,\n \"last_name\": \"Yadav\"\n }\n }\n ]\n}"}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get list of activities by ids. This does not include notes, call, email and calender activities.","tags":["Other APIs"]}},"/api/external/call/create":{"post":{"description":"\n**The below table describes the required input**\n\n|

Params

|

Data Type

|

Required

|\n| ------------------- | ------------------ | ----------------- |\n| associated_entities | object | True |\n| call_outcome_id | integer | True |\n| created_by | integer | True |\n| notes | object | optional |\n| title | string | optional |\n| start_time | date | True |\n| end_time | date | optional |\n| meeting_type_id | integer | optional |\n\n**Sample Payload**\n```\n{\n \"associated_entities\": {\n \"candidates\": [],\n \"clients\": [1] (Client Ids as Array of Integers),\n \"contacts\": [1, 2] (Contact Ids as Array of Integers),\n \"deals\": [1] (Job Ids as Array of Integer),\n \"jobs\": []\n },\n \"call_outcome_id\": 1 (Integer),\n \"meeting_type_id\": 1 (Integer),\n \"created_by\": 1 (Integer),\n \"notes\": {\n \"value\": \"notes\" (String),\n \"mentions\": [2] (User Ids as Array of Integers)\n },\n \"title\": \"Call Title\" (String),\n \"start_time\": \"2024-06-30T10:30:00+0000\" (Date in ISO format),\n \"end_time\": \"2024-06-30T10:30:00+0000\" (Date in ISO format)\n}\n```\n","parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"associated_entities":{"description":"The associated entities for the call.","properties":{"candidates":{"description":"The list of candidate ids associated with the call.","items":{"type":"integer"},"type":"array"},"clients":{"description":"The list of client ids associated with the call.","items":{"type":"integer"},"type":"array"},"contacts":{"description":"The list of contact ids associated with the call.","items":{"type":"integer"},"type":"array"},"deals":{"description":"The list of deal ids associated with the call.","items":{"type":"integer"},"type":"array"},"jobs":{"description":"The list of job ids associated with the call.","items":{"type":"integer"},"type":"array"}},"required":true,"type":"object"},"call_outcome_id":{"description":"The call outcome id.","required":true,"type":"integer"},"created_by":{"description":"The user id who created the call.","required":true,"type":"integer"},"end_time":{"description":"The end time of the call in ISO format.","example":"2024-06-30T10:30:00+0000","required":false,"type":"string"},"meeting_type_id":{"description":"The meeting type id.","example":1,"required":false,"type":"integer"},"notes":{"properties":{"mentions":{"description":"The list of user ids associated with the call.","items":{"type":"integer"},"type":"array"},"value":{"type":"string"}},"type":"object"},"start_time":{"description":"The start time of the call in ISO format.","example":"2024-06-30T10:30:00+0000","required":true,"type":"string"},"title":{"description":"The title of the call.","example":"Call Title","required":false,"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","data":{"call_id":29}}}},"description":"Auto generated using Swagger Inspector"},"400":{"content":{"application/json":{"example":{"RESULT":"FAILURE","message":"Please provide a valid call outcome id"}}},"description":"Auto generated using Swagger Inspector"},"403":{"content":{"application/json":{"example":{"RESULT":"FAILURE","message":"The specified user is not present in your account"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Create a call","tags":["Other APIs"]}},"/api/external/campaign/add-to-campaign":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"campaign_id":{"type":"integer"},"id":{"items":{"type":"integer"},"type":"array"},"user_id":{"type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"data":"SUCCESS","message":"Successfully added to the campaign","num_records":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Add candidate/contact to campaign","tags":["Campaign APIs"]}},"/api/external/campaign/get-campaign-report":{"get":{"parameters":[{"description":"Campaign id you want to fetch.","example":10,"explode":true,"in":"query","name":"campaign_id","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":{"total":{"bounced":0,"opened":0,"replied":0,"scheduled":0,"sent":0},"touchpoints":[]}}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"This endpoint lists all communications sent in a particular campaign","tags":["Campaign APIs"]}},"/api/external/campaign/list":{"get":{"parameters":[{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"bounces":0,"campaign_status_id":3,"created_by":{"email":"abc@def.com","first_name":"AB","id":2841,"last_name":"C","name":"ABC"},"errors":0,"id":5,"last_twenty_four_hour_count":0,"name":"Test Campaign","opens":0,"prospect_type_id":1,"replies":0,"schedules":0,"sends":0,"timezone":"(GMT+05:30) India Standard Time"},{"bounces":0,"campaign_status_id":3,"created_by":{"email":"abc@recruiterflow.com","first_name":"AB","id":3264,"last_name":"C","name":"AB C"},"errors":0,"id":1,"last_twenty_four_hour_count":0,"name":"Untitled campaign","opens":0,"prospect_type_id":1,"replies":0,"schedules":0,"sends":0,"timezone":"(GMT+05:30) India Standard Time"}],"total_items":2}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"This endpoint lists all campaigns created within Recruiterflow","tags":["Campaign APIs"]}},"/api/external/campaign/remove-from-campaign":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"campaign_id":{"type":"integer"},"id":{"items":{"type":"integer"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Remove candidate/contact from campaign.","tags":["Campaign APIs"]}},"/api/external/campaign/status/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":2,"name":"Active"},{"id":1,"name":"Inactive"},{"id":3,"name":"Stopped"},{"id":4,"name":"Stopped - No permissions"}],"total_items":4}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"This endpoint lists all campaign-related statuses","tags":["Campaign APIs"]}},"/api/external/candidate/activities/stage-movement/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Candidate ID for which the data is needed.","example":157877,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"id":"24","jobs":[{"added_by":{"email":"johndoe@example.com","id":1,"name":"John Doe"},"id":1,"name":"Avenger","transitions":[{"entered":"2023-03-22T10:01:10+0000","from":null,"left":null,"stage_moved_by":{"email":"johndoe@example.com","id":1,"name":"John Doe"},"to":"Sourced"}]},{"added_by":{"email":"johndoe@example.com","id":1,"name":"John Doe"},"id":3,"name":"Another job 321","transitions":[{"entered":"2023-03-29T14:26:38+0000","from":null,"left":"2023-03-29T14:26:43+0000","stage_moved_by":{"email":"johndoe@example.com","id":1,"name":"John Doe"},"to":"Sourced"},{"entered":"2023-03-29T14:26:43+0000","from":"Sourced","left":"2023-03-29T14:26:44+0000","stage_moved_by":{"email":"johndoe@example.com","id":1,"name":"John Doe"},"to":"Recruiter Screen"},{"entered":"2023-03-29T14:26:44+0000","from":"Recruiter Screen","left":"2023-03-29T14:26:46+0000","stage_moved_by":{"email":"johndoe@example.com","id":1,"name":"John Doe"},"to":"Company Submission"},{"entered":"2023-03-29T14:26:46+0000","from":"Company Submission","left":null,"stage_moved_by":{"email":"johndoe@example.com","id":1,"name":"John Doe"},"to":"Client Interview"}]}],"name":"Thor Odinson"}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all stage movements for a candidate","tags":["Candidate APIs"]}},"/api/external/candidate/activity-type/list":{"get":{"description":"Note: The keys \"track_last_contacted\" and \"track_last_engaged\" are used only for custom activity types.
For default activity types, these keys will always be False.
","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"category":"Communication","id":1,"is_archived":false,"is_custom":false,"name":"Note","rank":1,"track_last_contacted":false,"track_last_engaged":false},{"category":"Communication","id":2,"is_archived":false,"is_custom":false,"name":"Email","rank":2,"track_last_contacted":false,"track_last_engaged":false},{"category":"Job-related","id":3,"is_archived":false,"is_custom":false,"name":"Scorecard","rank":3,"track_last_contacted":false,"track_last_engaged":false},{"category":"Custom","id":1001,"is_archived":false,"is_custom":true,"name":"Lunch with candidate","rank":1001,"track_last_contacted":true,"track_last_engaged":true}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all activity types for candidate.","tags":["Candidate APIs"]}},"/api/external/candidate/activity/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Candidate ID for which the activities are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"activity_id":1000,"associated_entities":{"candidates":[{"id":22,"name":"Steve Rogers"}],"clients":[],"contacts":[],"deals":[],"jobs":[{"id":1,"name":"Software Engineer"}]},"candidate_id":22,"contact_id":null,"interview_plan_id":19,"is_custom":false,"job_id":1,"subject":"Candidate added to job","text":"Michael Scott added Steve Rogers to Software Engineer (Test Company)","time":"2023-12-18T12:17:00+00:00","type":{"id":9,"name":"Added to job"},"user":{"email":"test@testmail.com","first_name":"Michael","id":1,"last_name":"Scott","name":"Michael Scott"}}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get paginated list of activities for a candidate.","tags":["Candidate APIs"]}},"/api/external/candidate/add":{"post":{"description":"
Please find the format of custom field input below.
  • Single select:
    {
    \"id\": single_select_cf_id,
    \"value\": \"string\"
    }


  • Multi select :
    {
    \"id\": multi_select_cf_id,
    \"value\": [\"string1\", \"string2\"]
    }


  • Short/Long text:
    {
    \"id\": short_text_cf_id,
    \"value\": \"text\"
    }


  • Money:
    {
    \"id\": money custom field id,
    \"value\": {\"number\": Integer(The amount), \"currency\": \"string(Currency code eg. USD, GBP)\"}
    }

  • Money Range:
    {
    \"id\": money reange custom field id,
    \"value\": {\"number1\": Integer(Starting Amount), \"number2\": \"Ending Amount\", \"currency\": \"string(Currency code eg. USD, GBP)\"}
    }

  • Number/Date:
    {
    \"id\": cf_id,
    \"value\": number/date to store
    }


  • Yes No:
    {
    \"id\": yes_no_cf_id,
    \"value\": 0 for No and 1 for Yes
    }


  • Profile :
    {
    \"id\": profile_cf_id,
    \"value\": [{\"id\": profile_id, \"type\": entity_type(Candidate, Contact, Company)}]
    }


  • Parent-Child :
    {
    \"id\": parent-child-cf-id,
    \"value\": [{\"name\": \"parent_name\", \"children\": [\"child1\", \"child2\"]}]
    }


  • Users:
    {
    \"id\": users_cf_id,
    \"value\": [integer_user_id_1, integer_user_id_1]
    }

    • ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"name\" : \"swagger candidate\",\n \"email\" : [{\n \"email\": \"swagger@mail.com\",\n \"is_primary\" : 1\n }\n ],\n \"phone_number\" : [\n {\n \"phone_number\" : \"987689928\",\n \"type\" : 1\n }\n ],\n \"linkedin_profile\" : \"https://www.linkedin.com/in/abhishek-bachchan/\",\n \"twitter_profile\" : \"https://twitter.com/989fabd17d7341a\",\n \"facebook_profile\" : \"https://www.facebook.com/bikash.shaw.56884\",\n \"github_profile\" : \"https://github.com/bikashkumarshaw\",\n \"angellist_profile\" : \"https://angel.co/u/bikash-shaw-1\",\n \"tags\" : [\"swagger\"],\n \"skills\" : [\"swagger\"],\n \"title\" : \"swagger pos\",\n \"organization\" : \"swagger company\",\n \"source\" : \"linkedin\",\n \"lead_owner_id\" : 1,\n \"custom_fields\" : [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\", \"number\": 600000}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\", \"number1\": 600000, \"number2\": 800000}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000, \"number2\": 800000}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"]\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\"\n }\n ],\n \"location\" : {\n \"location\" : \"New York Metropolitan Area\",\n \"city\": \"New York city\",\n \"state\": \"New York\",\n \"country\": \"United States\",\n \"postal_code\": \"3256\"\n },\n \"experience\" : [\n {\"organization\":\"Facebook\",\n \"designation\":\"SDE\",\n \"from\":[\"2\",\"2021\"],\n \"to\":[\"2\",\"2021\"]\n }\n ],\n \"education\" : [\n {\"school\":\"HPCA\",\n \"degree\":\"10th\",\n \"specialization\": \"MATHS\",\n \"from\":[\"5\",\"2021\"],\n \"to\":[\"5\",\"2022\"]\n }\n ],\n \"added_time\" : \"2021-01-12T10:16:16+0000\"\n}"}},"schema":{"properties":{"added_time":{"type":"string"},"angellist_profile":{"type":"string"},"custom_fields":{"items":{"properties":{"id":{"type":"integer"},"value":{"type":"string"}},"type":"object"},"type":"array"},"education":{"items":{"properties":{"degree":{"type":"string"},"from":{"items":"type:string","type":"array"},"school":{"type":"string"},"specialization":{"type":"string"},"to":{"items":"type:string","type":"array"}},"type":"object"},"type":"array"},"email":{"items":{"properties":{"email":{"type":"string"},"is_primary":{"type":"integer"}},"type":"object"},"type":"array"},"experience":{"items":{"properties":{"designation":{"type":"string"},"from":{"items":"type:string","type":"array"},"organization":{"type":"string"},"to":{"items":"type:string","type":"array"}},"type":"object"},"type":"array"},"facebook_profile":{"type":"string"},"github_profile":{"type":"string"},"lead_owner_id":{"type":"integer"},"linkedin_profile":{"type":"string"},"location":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"type":"object"},"name":{"type":"string"},"organization":{"type":"string"},"phone_number":{"items":{"properties":{"phone_number":{"type":"string"},"type":{"type":"integer"}},"type":"object"},"type":"array"},"skills":{"items":{"type":"string"},"type":"array"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"twitter_profile":{"type":"string"},"websites":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","data":{"id":154721}},"schema":{"properties":{"RESULT":{"type":"string"},"data":{"properties":{"id":{"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Add a candidate record.","tags":["Candidate APIs"]}},"/api/external/candidate/add-application-form":{"post":{"description":"Use the 'key' of the application form parts (from /api/external/job) as the form element names to pass values for each application form input.
    Files can also be uploaded in the form using the appropriate 'key' from the application form detail.
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"id":{"type":"integer"},"job_id":{"type":"integer"},"personal_info.email":{"type":"string"},"personal_info.first_name":{"type":"string"},"personal_info.last_name":{"type":"string"},"personal_info.linkedin_profile":{"type":"string"},"personal_info.name":{"type":"string"},"personal_info.phone":{"type":"string"}},"required":["id","job_id"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS"},"schema":{"properties":{"RESULT":{"type":"string"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"The add application form endpoint allows you to export application information about a job to Recruiterflow.","tags":["Candidate APIs"]}},"/api/external/candidate/add-to-job":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"added_time":"2021-01-12T10:16:16+0000","applied":1,"id":123,"job_id":456},"schema":{"properties":{"added_time":{"type":"string"},"applied":{"description":"0 = Sourced (default when omitted), 1 = Applied. Applied triggers Welcome Mail recipes.","type":"integer"},"id":{"type":"integer"},"job_id":{"type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS"},"schema":{"properties":{"RESULT":{"type":"string"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Add a candidate to a job, candidates will show up under the Sourced stage","tags":["Candidate APIs"]}},"/api/external/candidate/calendar-event/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Candidate ID for which the tasks are needed.","example":157877,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"attachments":[],"attendees":[{"email":"tony.stark@avengers.com","name":"T Stark","status":null}],"calendar":{"calendar_id":"RANDOM_GOOGLE_CALENDAR","id":1,"name":"Google Calendar"},"description":"
    Will be tested on proficiency in saving the world!
    ","end_time":"2023-03-21T10:00:00+0000","entities":[{"id":25,"name":"Tony Stark","type":1}],"id":2,"interview":{},"organizer":{"email":"johndoe@example.com","name":"John Doe"},"start_time":"2023-03-21T09:00:00+0000","title":"Avenger: Technical Interview - I","user":{"id":1}},{"attachments":[],"attendees":[{"email":"tony.stark@avengers.com","name":"T Stark","status":null}],"calendar":{"calendar_id":"RANDOM_GOOGLE_CALENDAR","id":1,"name":"Google Calendar"},"description":"
    Will be tested on proficiency in saving the world!
    ","end_time":"2023-03-22T10:00:00+0000","entities":[{"id":25,"name":"Tony Stark","type":1}],"id":3,"interview":{},"organizer":{"email":"johndoe@example.com","name":"John Doe"},"start_time":"2023-03-22T09:00:00+0000","title":"Avenger: Technical Interview - II","user":{"id":1}},{"attachments":[],"attendees":[{"email":"tony.stark@avengers.com","name":"T Stark","status":null}],"calendar":{"calendar_id":"RANDOM_GOOGLE_CALENDAR","id":1,"name":"Google Calendar"},"description":"
    Will be tested on proficiency in saving the world!
    ","end_time":"2023-03-23T10:00:00+0000","entities":[{"id":25,"name":"Tony Stark","type":1}],"id":1,"interview":{},"organizer":{"email":"johndoe@example.com","name":"John Doe"},"start_time":"2023-03-23T09:00:00+0000","title":"Avenger: Practical Test","user":{"id":1}}],"total_items":3}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all calendar events for a candidate","tags":["Candidate APIs"]}},"/api/external/candidate/calls/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Candidate ID for which the calls are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"end_time":"2023-05-01T03:36:00+0000","entities":[{"id":22,"name":"Steve Rogers","type":"Candidate"}],"id":1,"meeting_type":"Meeting Type","notes":{"notes":"
    HI test call
    ","users":[]},"outcome":"Busy","start_time":"2023-05-01T02:36:00+0000","title":"Call Title","user":{"id":1,"name":"Tony Stark"}}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all calls list for a candidate","tags":["Candidate APIs"]}},"/api/external/candidate/custom-field/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"choices":[{"id":855,"name":"Basic"},{"id":856,"name":"Moderate"},{"id":857,"name":"High"},{"id":858,"name":"Expert"}],"id":245,"name":"Proficiency","type":"single_select"}],"total_items":1},"schema":{"items":{"properties":{"choices":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"type":"array"},"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"The endpoint lists all candidate custom fields.","tags":["Candidate APIs"]}},"/api/external/candidate/disqualify":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"added_time":{"description":"Time when the candidate was disqualified. (Optional)","example":"2021-01-12T10:16:16+0000","type":"string"},"id":{"description":"Candidate ID","type":"integer"},"job_id":{"description":"Job ID","type":"integer"},"reason":{"description":"Reason for disqualification.","type":"string"},"user_id":{"description":"User ID disqualifying a candidate.","type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Disqualify a candidate with a reason.","tags":["Candidate APIs"]}},"/api/external/candidate/emails/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Candidate ID for which the calls are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"gmail_thread_id":"dsflads2378r23nfdkjs","id":1,"messages":[{"attachments":[],"body":"
    Test email
    ","cc":[],"from":"Tony Stark ","from_initials":"T","from_name":"Tony Stark","gmail_message_id":"sdf32q0239ew12321","id":1,"opens":[],"sender":{"email":"tony.stark@recruiterflow.com","message_id":1,"name":"Tony Stark"},"sent":"2022-08-01T09:00:00+0000","subject":"Thanos is coming, we need you!","to":[{"email":"captain.america@avengers.com","message_id":1,"name":""}]}]}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all emails list for a Candidate","tags":["Candidate APIs"]}},"/api/external/candidate/file/add":{"post":{"description":"If file is being added by url, file_name is mandatory
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file_name":{"type":"string"},"files":{"format":"binary","type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","data":{"num_files":3}},"schema":{"properties":{"RESULT":{"type":"string"},"data":{"properties":{"num_files":{"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Please add ARGUMENTS (AS A FORM), the api is used to attach files to candidates.","tags":["Candidate APIs"]}},"/api/external/candidate/get":{"get":{"parameters":[{"description":"Prospect id you want to fetch.","example":10,"explode":true,"in":"query","name":"id","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":[{"added_by":{"id":18993,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/18993/profile-picture.jpe","name":"Bikash Shaw"},"added_time":"2021-01-15T05:46:01+0000","angellist_profile":null,"behance_profile":null,"client":null,"client_company_id":null,"current_designation":null,"current_organization":null,"custom_fields":[],"do_not_email":false,"dribbble_profile":null,"education":[],"email":[],"experience":[],"facebook_profile":null,"files":[{"filename":"10250.pdf","id":3202,"link":"https://com-recruiterflow-document-store-eu.s3.amazonaws.com/db_b18c893c749e320e66fbb2f7fef6b1be/documents/3202/10250.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJGJEHP5AAWSJVTMA%2F20210118%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210118T120927Z&X-Amz-Expires=604700&X-Amz-SignedHeaders=host&X-Amz-Signature=b2f5c36db2ea531754e94ce7cf821740effbbf58dca0e7c383880d716b3b8674","permission":1,"upload_time":"2021-01-18T11:34:16+05:30"}],"first_name":"Sumit","github_profile":"None","id":154651,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/profile-pictures/prod/db_b18c893c749e320e66fbb2f7fef6b1be/154651/profile-picture.jpe","jobs":[{"added_to_job_by":{"id":"","name":""},"client_company_id":"","client_company_name":"","department_name":"","disqualification_reason":"","is_open":"","job_id":"","job_visibility_id":"","locations":[{"city":"","country":"","id":"","iso_3166_1_alpha_2_code":"","name":"","postal_code":"","state":"","zipcode":""}],"name":"","stage_moved":"","stage_name":"","stages":[{"id":"","name":"","rank":""}],"starred":""}],"last_contact_type":null,"last_contacted":null,"last_engaged":null,"last_engagement_type":null,"last_name":"Neogi","latest_activity_time":"2021-01-18T06:04:16+0000","lead_owner":{"id":18993,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/18993/profile-picture.jpe","name":"Bikash Shaw"},"linkedin_profile":"sumitneogi","location":{"city":"","country":"","google_place_id":"","location":"","postal_code":"","state":"","street_address_1":"","street_address_2":""},"name":"Sumit Neogi","notes":[],"phone_number":["23432443"],"prospect_id":154651,"prospect_type_id":1,"skills":[],"source_name":"LinkedIn","status":{"id":null,"name":null},"submission_times":[],"tags":[],"twitter_profile":null,"upcoming_activities":{},"xing_profile":null}]}},"description":"Auto generated using Swagger Inspector"}},"summary":"Fields are the same as the candidate list API above.","tags":["Candidate APIs"]}},"/api/external/candidate/list":{"get":{"parameters":[{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Include candidate files in response, defaults to False.","example":0,"explode":true,"in":"query","name":"include_files","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Include candidate notes in response, defaults to False.","example":1,"explode":true,"in":"query","name":"include_notes","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"added_by":{"id":18993,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/18993/profile-picture.jpe","name":"Bikash Shaw"},"added_time":"2021-01-15T05:46:01+0000","angellist_profile":null,"behance_profile":null,"client":null,"client_company_id":null,"current_designation":null,"current_organization":null,"custom_fields":[],"do_not_email":false,"dribbble_profile":null,"education":[],"email":[],"experience":[],"facebook_profile":null,"files":[{"filename":"10250.pdf","id":3202,"link":"https://com-recruiterflow-document-store-eu.s3.amazonaws.com/db_b18c893c749e320e66fbb2f7fef6b1be/documents/3202/10250.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJGJEHP5AAWSJVTMA%2F20210118%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210118T120927Z&X-Amz-Expires=604700&X-Amz-SignedHeaders=host&X-Amz-Signature=b2f5c36db2ea531754e94ce7cf821740effbbf58dca0e7c383880d716b3b8674","permission":1,"upload_time":"2021-01-18T11:34:16+05:30"}],"first_name":"Sumit","github_profile":"None","id":154651,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/profile-pictures/prod/db_b18c893c749e320e66fbb2f7fef6b1be/154651/profile-picture.jpe","jobs":[{"added_to_job_by":{"id":"","name":""},"client_company_id":"","client_company_name":"","department_name":"","disqualification_reason":"","is_open":"","job_id":"","job_visibility_id":"","name":"","stage_moved":"","stage_name":"","starred":""}],"last_contact_type":null,"last_contacted":null,"last_engaged":null,"last_engagement_type":null,"last_name":"Neogi","latest_activity_time":"2021-01-18T06:04:16+0000","lead_owner":{"id":18993,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/18993/profile-picture.jpe","name":"Bikash Shaw"},"linkedin_profile":"sumitneogi","location":{"city":"","country":"","google_place_id":"","location":"","postal_code":"","state":"","street_address_1":"","street_address_2":""},"name":"Sumit Neogi","notes":[],"phone_number":["23432443"],"prospect_id":154651,"prospect_type_id":1,"skills":[],"source_name":"LinkedIn","status":{"id":null,"name":null},"submission_times":[],"tags":[],"twitter_profile":null,"upcoming_activities":{},"xing_profile":null}],"total_items":1},"schema":{"items":{"properties":{"added_by":{"properties":{"id":{"type":"integer"},"img_link":{"type":"string"},"name":{"type":"string"}},"type":"object"},"added_time":{"type":"string"},"angellist_profile":{"type":"string"},"behance_profile":{"type":"string"},"client":{"type":"object"}},"type":"object"},"type":"array"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get details of a particular candidate record","tags":["Candidate APIs"]}},"/api/external/candidate/move-to-stage":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"added_time":{"description":"Time when the candidate was moved to the stage. (Optional)","example":"2021-01-12T10:16:16+0000","type":"string"},"id":{"description":"Candidate ID","type":"integer"},"job_id":{"description":"Job ID (required only in case you have specified the stage name)","type":"integer"},"stage":{"properties":{"id":{"description":"Stage ID of the destination stage","type":"integer"},"name":{"description":"Stage name of the destination stage","type":"string"}},"type":"object"},"user_id":{"description":"User ID moving the Prospect.","type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Move a candidate to a stage in a job","tags":["Candidate APIs"]}},"/api/external/candidate/notes/add":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"created_by":{"type":"integer"},"id":{"description":"id of the candidate.","type":"integer"},"mentions":{"items":{"type":"integer"},"type":"array"},"value":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"note_id":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"The endpoint adds notes to the specified candidate.","tags":["Candidate APIs"]}},"/api/external/candidate/placement-record/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Candidate ID for which the placement records are needed.","example":157877,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"bill_rate":{"currency":null,"frequency":{"display_name":null,"id":null,"name":null},"number":null},"billing_date":"2023-05-16","bonus":{"currency":null,"number":null},"contract_end_date":null,"contract_start_date":null,"custom_fields":{"id":1,"name":null,"rank":1,"unique_key":null,"value":{"currency":null,"date_value":null,"department":null,"id":1,"long_text":null,"multi_select":null,"multi_select_name":null,"number1_value":null,"number2_value":null,"number_value":null,"rich_text":null,"short_text":null,"single_select":null,"single_select_name":null,"user_id":null,"yes_no":null},"view_field_id":1},"id":1,"job":{"client_company":{"id":1,"name":"S.H.I.E.L.D."},"id":1,"job_type":{"id":null,"name":null},"job_visibility_id":6,"name":"Avenger"},"job_start_date":"2023-05-16","note":"","pay_rate":{"currency":null,"frequency":{"display_name":null,"id":null,"name":null},"number":null},"prospect":{"id":22,"name":"Steve Rogers"},"retainer":{"currency":null,"frequency":{"display_name":null,"id":null,"name":null},"number":null},"revenue":{"currency":"USD","number":200},"salary":{"currency":"USD","number":200},"success_fee":{"currency":null,"number":null},"user":{"id":1},"version":{"id":1},"work_quantum":{"frequency":{"display_name":null,"id":null,"name":null},"is_full_time":false,"number":null,"unit":{"display_name":null,"id":null,"name":null}}}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all placement records for a candidate","tags":["Candidate APIs"]}},"/api/external/candidate/profile-image/upload":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Candidate ID for which the image is being updated","example":157877,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Content of the profile image in base64-encoded format","example":"abcdef==","explode":false,"in":"query","name":"img","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"File name of the profile image","example":"profile-picture.png","explode":false,"in":"query","name":"filename","required":false,"schema":{"type":"string"},"style":"simple"}],"summary":"Update profile picture for a candidate","tags":["Candidate APIs"]}},"/api/external/candidate/rating/get":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Candidate ID","explode":false,"in":"query","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"id":12345,"rating":4}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get the star rating (1-5) of a candidate.","tags":["Candidate APIs"]}},"/api/external/candidate/rating/update":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"Candidate ID","type":"integer"},"rating":{"description":"Rating from 1 to 5. Pass null (or 0) to clear the rating.","type":"integer"},"user_id":{"description":"User ID setting the rating.","type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Set (or clear) the star rating (1-5) of a candidate.","tags":["Candidate APIs"]}},"/api/external/candidate/scorecard/get":{"get":{"parameters":[{"description":"scorecard id.","example":111,"explode":true,"in":"query","name":"id","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"candidate":{"id":152340},"interview":{"id":1359,"name":"Phone Interview"},"job":{"id":334,"name":"scorecard_test_staging2"},"scorecard":{"bottomline":"yes","id":111,"notes":"Notes","questions":[{"id":72,"response":"","text":"check1 question"},{"id":73,"response":"","text":"check2 question"}],"submission_time":"2020-08-13 10:16:20"},"stage":{"id":3221,"name":"Phone Interview"}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"This API returns scorecard details specified.","tags":["Candidate APIs"]}},"/api/external/candidate/scorecard/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Candidate ID for which the scorecards are needed.","example":157877,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Job ID for which the scorecard is needed.","example":784,"explode":false,"in":"query","name":"job_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"candidate":{"id":56,"name":"Fenandez Orro"},"job":[{"id":1,"name":"Data Scientist","stages":[{"id":316,"name":"On-site Interview","scorecards":[{"attributes":[{"category":{"name":"Polynovo Hiring for Attitude Questions "},"name":"Could you tell me about a time you had a challenging situation or goal? ","notes":"","rank":3,"rating":5}],"bottomline":"yes","first_name":"Anuj","id":89,"last_name":"Singh","middle_name":"None","name":"Candidate Interview.","notes":"Lovely","questions":[{"category_name":"Technical questions","id":25,"response":"Python is good","text":"What is python?"}],"result_id":3,"submission_time":"2021-07-05 11:45:21","user_id":3}]}]}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all scorecards for a candidate and job_id","tags":["Candidate APIs"]}},"/api/external/candidate/search":{"post":{"description":"Link

    Note: Structure changes to {\"data\": [], \"total_items\": int} when include_count is enabled.

    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"items_per_page\": 20,\n \"conjunction\": \"match-all\", \n \"filters\": [\n {\n \"filter_type\": \"less-than\", \n \"is_relative\": true, \n \"key\": \"last_activity\", \n \"name\": \"Last activity\", \n \"rank\": 1050,\n \"status\": \"COMPLETE\",\n \"text\": \"less than 10 days ago\",\n \"type\": \"date\",\n \"days\": 10\n }\n ], \n \"current_page\": 1,\n \"include_count\": true\n}"},"1":{"value":"{\n \"conjunction\": \"match-all\", \n \"current_page\": 1, \n \"filters\": [\n {\n \"filter_type\": \"less-than\", \n \"is_relative\": true, \n \"key\": \"last_activity\", \n \"name\": \"Last activity\", \n \"rank\": 1050,\n \"status\": \"COMPLETE\",\n \"text\": \"less than 10 days ago\",\n \"type\": \"date\",\n \"days\": 10\n }\n ], \n \"items_per_page\": 20\n}"}},"schema":{"properties":{"conjunction":{"type":"string"},"current_page":{"type":"string"},"filters":{"items":{"properties":{"days":{"type":"string"},"filter_type":{"type":"string"},"include_calls":{"type":"boolean"},"include_custom_activities":{"type":"boolean"},"include_emails":{"type":"boolean"},"include_texts":{"type":"boolean"},"is_relative":{"type":"boolean"},"key":{"type":"string"}},"type":"object"},"type":"array"},"include_count":{"type":"boolean"},"items_per_page":{"type":"string"}},"required":["items_per_page","conjunction","current_page"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"data":[{"added_by":{"id":30273,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/30273/profile-picture.png","name":"Manish Kotian"},"added_time":"2020-11-26T12:06:23+0000","angellist_profile":"None","behance_profile":"None","client":"None","client_company_id":"None","client_company_name":"None","current_designation":"None","current_organization":"None","custom_fields":[],"do_not_email":false,"dribbble_profile":"None","email":[{"email":"manish+7@recruiterflow.com","is_primary":true}],"facebook_profile":"None","first_name":"TestCandidateManish","github_profile":"None","id":153905,"img_link":"None","jobs":[{"application_form_id":"None","client_company_id":4,"client_company_name":"Akpe","department_name":"Engineering","disqualification_reason":"None","job_id":139,"job_visibility_id":1,"locations":[{"city":"California","country":"United States","id":5,"iso_3166_1_alpha_2_code":"US","name":"San Francisco","postal_code":"","state":"California","zipcode":""}],"name":"shreyastestjob","stage_id":1074,"stage_moved":"2020-11-26T17:36:19+0000","stage_name":"Sourced","stages":[{"id":1074,"name":"Sourced","rank":1},{"id":1065,"name":"Applied","rank":2},{"id":1073,"name":"Phone Interview","rank":3},{"id":1067,"name":"Company Submission","rank":4},{"id":1075,"name":"stage test","rank":5},{"id":1066,"name":"Client Interview 1","rank":6},{"id":1068,"name":"Custom stage 1","rank":7},{"id":1069,"name":"customstage2","rank":8},{"id":1070,"name":"Disqualified","rank":9},{"id":1072,"name":"Offer","rank":10},{"id":1071,"name":"Hired","rank":11}]}],"last_contact_type":1,"last_contacted":"2020-11-30T07:48:49+0000","last_engaged":"None","last_engagement_type":"None","last_name":"","latest_activity_time":"None","lead_owner":{"id":30273,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/30273/profile-picture.png","name":"Manish Kotian"},"linkedin_profile":"None","location":{"city":"","country":"","google_place_id":"","location":"","postal_code":"","state":"","street_address_1":"","street_address_2":""},"name":"TestCandidateManish","phone_number":[],"prospect_id":153905,"prospect_type_id":1,"source_name":"None","status":{"id":"None","name":"None"},"submission_times":[],"tags":["Java"],"twitter_profile":"None","upcoming_activities":{},"xing_profile":"None"}],"rank":{},"total_items":21}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Find all search types in the link below.","tags":["Candidate APIs"]}},"/api/external/candidate/task/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Candidate ID for which the tasks are needed.","example":157877,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"assignees":[{"email":"johndoe@example.com","first_name":"John","id":1,"last_name":"Doe","name":"John Doe"}],"created_by":{"email":"johndoe@example.com","id":1,"name":"johndoe@example.com"},"due_date":"2023-03-29T03:30:00+0000","entered_due_date":"2023-03-29T09:00:00+0000","entered_reminder_time":"2023-03-29T09:00:00+05:30","entities":[{"id":25,"name":"Tony Stark","type":1}],"id":1,"is_over_due":true,"name":"test task","notes":"
    test task
    ","prospects":[],"reminder_time":"2023-03-29T03:30:00+0000","task_status":"Open","task_type":"Email"},{"assignees":[{"email":"johndoe@example.com","first_name":"John","id":1,"last_name":"Doe","name":"John Doe"}],"created_by":{"email":"johndoe@example.com","id":1,"name":"John Doe"},"due_date":"2023-03-29T03:30:00+0000","entered_due_date":"2023-03-29T09:00:00+0000","entered_reminder_time":"2023-03-29T09:00:00+05:30","entities":[{"id":25,"name":"Tony Stark","type":1}],"id":2,"is_over_due":true,"name":"test task 1","notes":"
    test task 1
    ","prospects":[],"reminder_time":"2023-03-29T03:30:00+0000","task_status":"Open","task_type":"Email"},{"assignees":[{"email":"johndoe@example.com","first_name":"John","id":1,"last_name":"Doe","name":"John Doe"}],"created_by":{"email":"johndoe@example.com","id":1,"name":"John Doe"},"due_date":"2023-03-29T03:30:00+0000","entered_due_date":"2023-03-29T09:00:00+0000","entered_reminder_time":"2023-03-29T09:00:00+05:30","entities":[{"id":25,"name":"Tony Stark","type":1}],"id":3,"is_over_due":true,"name":"test task 2","notes":"
    test task 3
    ","prospects":[],"reminder_time":"2023-03-29T03:30:00+0000","task_status":"Open","task_type":"Email"}],"total_items":3}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all tasks for a candidate","tags":["Candidate APIs"]}},"/api/external/candidate/update":{"post":{"description":"Please find the format of custom field input below.
  • Single select:
    {
    \"id\": single_select_cf_id,
    \"value\": \"string\"
    }


  • Multi select :
    {
    \"id\": multi_select_cf_id,
    \"value\": [\"string1\", \"string2\"]
    }


  • Short/Long text:
    {
    \"id\": short_text_cf_id,
    \"value\": \"text\"
    }


  • Money:
    {
    \"id\": money custom field id,
    \"value\": {\"number\": Integer(The amount), \"currency\": \"string(Currency code eg. USD, GBP)\"}
    }

  • Money Range:
    {
    \"id\": money reange custom field id,
    \"value\": {\"number1\": Integer(Starting Amount), \"number2\": \"Ending Amount\", \"currency\": \"string(Currency code eg. USD, GBP)\"}
    }

  • Number/Date:
    {
    \"id\": cf_id,
    \"value\": number/date to store
    }


  • Yes No:
    {
    \"id\": yes_no_cf_id,
    \"value\": 0 for No and 1 for Yes
    }


  • Profile:
    {
    \"id\": profile_cf_id,
    \"value\": [{\"type\": \"candidate\", \"id\": candidate_id}]
    }


  • Users:
    {
    \"id\": users_cf_id,
    \"value\": [integer_user_id_1, integer_user_id_1]
    }


  • Parent-Child :
    {
    \"id\": parent-child-cf-id,
    \"value\": [{\"name\": \"parent_name\", \"children\": [\"child1\", \"child2\"]}]
    }


    • ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"name\" : \"swagger contact\",\n \"first_name\" : \"swagger\",\n \"last_name\" : \"contact\",\n \"email\" : [{\n \"email\": \"swagger@mail.com\",\n \"is_primary\" : 1\n }\n ],\n \"id\" : 5157,\n \"phone_number\" : [\n {\n \"phone_number\" : \"987689928\",\n \"type\" : 1\n }\n ],\n \"linkedin_profile\" : \"https://www.linkedin.com/in/abhishek-bachchan/\",\n \"twitter_profile\" : \"https://twitter.com/989fabd17d7341a\",\n \"facebook_profile\" : \"https://www.facebook.com/bikash.shaw.56884\",\n \"github_profile\" : \"https://github.com/bikashkumarshaw\",\n \"angellist_profile\" : \"https://angel.co/u/bikash-shaw-1\",\n \"tags\" : [\"swagger\"],\n \"skills\" : [\"swagger\"],\n \"title\" : \"swagger pos\",\n \"organization\" : \"swagger company\",\n \"source\" : \"linkedin\",\n \"custom_fields\" : [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\", \"number\": 600000}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\", \"number1\": 600000, \"number2\": 800000}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000, \"number2\": 800000}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"]\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\"\n }\n ],\n \"location\" :{\n \"location\" : \"New York Metropolitan Area\",\n \"city\": \"New York city\",\n \"state\": \"New York\",\n \"country\": \"United States\",\n \"postal_code\": \"3256\"\n },\n \"experience\" : [\n {\"organization\":\"Facebook\",\n \"designation\":\"SDE\",\n \"from\":[\"2\",\"2021\"],\n \"to\":[\"2\",\"2021\"]\n }\n ],\n \"education\" : [\n {\"school\":\"HPCA\",\n \"degree\":\"10th\",\n \"specialization\": \"MATHS\",\n \"from\":[\"5\",\"2021\"],\n \"to\":[\"5\",\"2022\"]\n }\n ]\n}"}},"schema":{"properties":{"angellist_profile":{"type":"string"},"custom_fields":{"items":{"properties":{"id":{"type":"integer"},"value":{"type":"string"}},"type":"object"},"type":"array"},"education":{"items":{"properties":{"degree":{"type":"string"},"from":{"items":"type:string","type":"array"},"school":{"type":"string"},"specialization":{"type":"string"},"to":{"items":"type:string","type":"array"}},"type":"object"},"type":"array"},"email":{"items":{"properties":{"email":{"type":"string"},"is_primary":{"type":"integer"}},"type":"object"},"type":"array"},"experience":{"items":{"properties":{"designation":{"type":"string"},"from":{"items":"type:string","type":"array"},"organization":{"type":"string"},"to":{"items":"type:string","type":"array"}},"type":"object"},"type":"array"},"facebook_profile":{"type":"string"},"github_profile":{"type":"string"},"id":{"type":"integer"},"linkedin_profile":{"type":"string"},"name":{"type":"string"},"organization":{"type":"string"},"phone_number":{"items":{"properties":{"phone_number":{"type":"string"},"type":{"type":"integer"}},"type":"object"},"type":"array"},"skills":{"items":{"type":"string"},"type":"array"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"twitter_profile":{"type":"string"},"websites":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS"},"schema":{"properties":{"RESULT":{"type":"string"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"This API implements a complete update which means that any existing data in the provided key will be wiped out and replaced with the data provided, in case a key is not provided no update happens to it.","tags":["Candidate APIs"]}},"/api/external/client/activity-type/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"category":"Communication","id":1,"is_archived":false,"is_custom":false,"name":"Note","rank":1},{"category":"Communication","id":2,"is_archived":false,"is_custom":false,"name":"Email","rank":2},{"category":"Job-related","id":3,"is_archived":false,"is_custom":false,"name":"Scorecard","rank":3},{"category":"Custom","id":1001,"is_archived":false,"is_custom":true,"name":"Lunch with candidate","rank":1001}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all activity types for client.","tags":["Client APIs"]}},"/api/external/client/activity/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Client ID for which the activities are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"activity_id":2978,"associated_entities":{"candidates":[],"clients":[{"id":1,"name":"Test Company"}],"contacts":[],"deals":[],"jobs":[]},"candidate_id":null,"contact_id":null,"interview_plan_id":null,"is_custom":false,"job_id":null,"subject":"Company created","text":"Michael Scott created the company Test Company","time":"2023-11-22T16:14:15+05:30","type":{"id":11,"name":"Add client company"},"user":{"email":"testemail@testdomain.com","first_name":"Michael","id":1,"last_name":"Scott","name":"Michael Scott"}}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get paginated list of activities for a client.","tags":["Client APIs"]}},"/api/external/client/add":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"name\" : \"swagger company swagging\",\n \"phone_number\" : \"987689928\",\n \"linkedin_page\" : \"https://www.linkedin.com/in/abhishek-bachchan/\",\n \"careers_page\" : \"https://twitter.com/989fabd17d7341a\",\n \"domain\" : \"https://www.nutanix.com\",\n \"lead_owner_id\" : 1,\n \"added_by\" : 1,\n \"industry_id\" : 1,\n \"company_size\" : \"2\",\n \"revenue\" : {\n \"currency\": \"USD\",\n \"number\": \"1000\"\n },\n \"location\" : {\n \"city\": \"Dallas\",\n \"country\": \"United States\",\n \"location\": \"Dallas, TX, USA\",\n \"postal_code\": \"\",\n \"state\": \"Texas\",\n \"street_address_1\": \"\",\n \"street_address_2\": \"\"\n },\n \"status_id\" : 3,\n \"tags\" : [\"swagger\"],\n \"custom_fields\" : [ \n { \n \"id\" : 30,\n \"value\" : [\"Random\"]\n }\n ],\n \"added_time\" : \"2024-06-08T08:43:58+0000\"\n}"}},"schema":{"properties":{"added_by":{"type":"integer"},"added_time":{"type":"string"},"careers_page":{"type":"string"},"company_size":{"description":"acceptable values fetched from https://recruiterflow.com/api/external/company-size/list","type":"string"},"custom_fields":{"items":{"properties":{"id":{"type":"integer"},"value":{"items":{"type":"string"},"type":"array"}},"type":"object"},"type":"array"},"domain":{"type":"string"},"industry_id":{"type":"integer"},"lead_owner_id":{"type":"integer"},"linkedin_page":{"type":"string"},"location":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"location":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"},"street_address_1":{"type":"string"},"street_address_2":{"type":"string"}},"type":"object"},"name":{"type":"string"},"phone_number":{"type":"string"},"revenue":{"properties":{"currency":{"type":"string"},"number":{"type":"string"}},"type":"object"},"status_id":{"type":"integer"},"tags":{"items":{"type":"string"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":{"id":1}}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"This enpoint is used to add client company.","tags":["Client APIs"]}},"/api/external/client/calls/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Client Company ID for which the calls are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"end_time":"2023-05-01T03:36:00+0000","entities":[{"id":22,"name":"S.H.E.I.L.D.","type":"Company"}],"id":1,"meeting_type":"Meeting Type","notes":{"notes":"
    HI test call
    ","users":[]},"outcome":"Busy","start_time":"2023-05-01T02:36:00+0000","title":"Call Title","user":{"id":1,"name":"Tony Stark"}}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all calls list for a client company","tags":["Client APIs"]}},"/api/external/client/custom-field/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":236,"name":"Is active?","type":"yes_no"},{"choices":[{"id":731,"name":"ms1"},{"id":732,"name":"ms2"},{"id":733,"name":"ms3"},{"id":734,"name":"ms4"},{"id":798,"name":"s2"}],"id":56,"name":"Multi Select","type":"multi_select"},{"id":40,"name":"Expected Billing","type":"money"}],"total_items":3}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all company custom fields.","tags":["Client APIs"]}},"/api/external/client/file/add":{"post":{"description":"If file is being added by url, file_name is mandatory
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file_name":{"type":"string"},"files":{"format":"binary","type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","data":{"num_files":3}},"schema":{"properties":{"RESULT":{"type":"string"},"data":{"properties":{"num_files":{"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Please add ARGUMENTS (AS A FORM), the api is used to attach files to client companies.","tags":["Client APIs"]}},"/api/external/client/get":{"get":{"parameters":[{"description":"company id.","example":1,"explode":true,"in":"query","name":"id","required":false,"schema":{"type":"integer"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"added_by":{"email":"admin@recruiterflow.com","id":3264,"name":"System Admin"},"added_time":null,"careers_page":"https://www.ixigo.com/about/careers/","closed_jobs":[{"candidates_hired":0,"candidates_submitted":0,"client_company_contacts":[],"department_name":"Engineering","id":91,"job_visibility_id":6,"last_opened":"2020-10-01T05:49:51+0000","locations":[{"city":"Kolkata","country":"India","id":13,"iso_3166_1_alpha_2_code":"IN","name":"Test","postal_code":"700036","state":"West bengal","zipcode":"700036"}],"name":"New Job Pipeline"}],"company_size":3,"company_size_name":"51-200","complete_address":"Golf Course Road, DLF Phase 5, Sector 53, Gurugram, Haryana, India, 122002","contacts":[{"designation":null,"id":154613,"img_link":null,"is_primary":false,"name":"Blah Ixigo"}],"custom_fields":[{"id":43,"name":"Close By","value":"2020-04-16"}],"domain":"gmail.com","files":[],"followers":[],"id":1,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/client-company-logos/prod/client/db_b18c893c749e320e66fbb2f7fef6b1be/1/logo.png","industry_id":13,"industry_name":"Internet","lead_owner":{"email":"admin@recruiterflow.com","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","name":"System Admin"},"linkedin_page":"","location":{"city":"Gurugram","country":"India","google_place_id":"ChIJLVyTdrQYDTkRrzz-1CTXg_M","latitude":null,"location":"ixigo, Golf Course Road, Parsvnath Exotica, DLF Phase 5, Sector 53, Gurugram, Haryana, India","longitude":null,"postal_code":"122002","state":"Haryana","street_address_1":"Golf Course Road","street_address_2":"DLF Phase 5, Sector 53"},"name":"Ixigo","notes":[{"author":{"email":"admin@recruiterflow.com","first_name":"System","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","last_name":"Admin","name":"System Admin"},"author_email":"admin@recruiterflow.com","author_first_name":"System","author_img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","author_last_name":"Admin","content":"
    @Naresh Shenoy How are you doing?
    ","created_time":"2021-01-13T19:20:10+0000","entities":[{"id":154613,"name":"Blah Ixigo","type":2},{"id":1,"name":"Ixigo","type":3}],"is_pinned":false,"replies":[{"author":{"email":"admin@recruiterflow.com","first_name":"System","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","last_name":"Admin","name":"System Admin"},"author_email":"admin@recruiterflow.com","author_first_name":"System","author_img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","author_last_name":"Admin","content":"
    @System Admin Hi there, edited
    ","created_time":"2021-01-13T19:22:32+0000","entities":[{"id":154613,"name":"Blah Ixigo","type":2},{"id":1,"name":"Ixigo","type":3}],"is_pinned":false}]}],"open_jobs":[{"candidates_hired":0,"candidates_submitted":0,"client_company_contacts":[],"department_name":"Engineering","id":1115,"job_visibility_id":1,"last_opened":"2021-01-04T10:02:18+0000","locations":[{"city":"Bangalore","country":"India","id":1,"iso_3166_1_alpha_2_code":"IN","name":"Bengaluru","postal_code":"700036","state":"Karnataka","zipcode":"700036"}],"name":"Senior Backend Developer"}],"phone_number":[],"pipeline":{"candidates_hired":1,"candidates_submitted":0},"revenue":{"currency":"USD","number":5000000},"status":{"id":null,"name":null},"subsidiary_companies":[],"tags":[]}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get client company details for the specified client.","tags":["Client APIs"]}},"/api/external/client/list":{"get":{"parameters":[{"example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"added_by":{"email":"admin@recruiterflow.com","id":3264,"name":"System Admin"},"added_time":null,"careers_page":"https://www.ixigo.com/about/careers/","closed_jobs":[{"candidates_hired":0,"candidates_submitted":0,"client_company_contacts":[],"department_name":"Engineering","id":91,"job_visibility_id":6,"last_opened":"2020-10-01T05:49:51+0000","locations":[{"city":"Kolkata","country":"India","id":13,"iso_3166_1_alpha_2_code":"IN","name":"Test","postal_code":"700036","state":"West bengal","zipcode":"700036"}],"name":"New Job Pipeline"}],"company_size":3,"company_size_name":"51-200","complete_address":"Golf Course Road, DLF Phase 5, Sector 53, Gurugram, Haryana, India, 122002","contacts":[{"designation":null,"id":154613,"img_link":null,"is_primary":false,"name":"Blah Ixigo"}],"custom_fields":[{"id":43,"name":"Close By","value":"2020-04-16"}],"domain":"gmail.com","files":[],"followers":[],"id":1,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/client-company-logos/prod/client/db_b18c893c749e320e66fbb2f7fef6b1be/1/logo.png","industry_id":13,"industry_name":"Internet","lead_owner":{"email":"admin@recruiterflow.com","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","name":"System Admin"},"linkedin_page":"","location":{"city":"Gurugram","country":"India","google_place_id":"ChIJLVyTdrQYDTkRrzz-1CTXg_M","latitude":null,"location":"ixigo, Golf Course Road, Parsvnath Exotica, DLF Phase 5, Sector 53, Gurugram, Haryana, India","longitude":null,"postal_code":"122002","state":"Haryana","street_address_1":"Golf Course Road","street_address_2":"DLF Phase 5, Sector 53"},"name":"Ixigo","notes":[{"author":{"email":"admin@recruiterflow.com","first_name":"System","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","last_name":"Admin","name":"System Admin"},"author_email":"admin@recruiterflow.com","author_first_name":"System","author_img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","author_last_name":"Admin","content":"
    @Naresh Shenoy How are you doing?
    ","created_time":"2021-01-13T19:20:10+0000","entities":[{"id":154613,"name":"Blah Ixigo","type":2},{"id":1,"name":"Ixigo","type":3}],"is_pinned":false,"replies":[{"author":{"email":"admin@recruiterflow.com","first_name":"System","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","last_name":"Admin","name":"System Admin"},"author_email":"admin@recruiterflow.com","author_first_name":"System","author_img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","author_last_name":"Admin","content":"
    @System Admin Hi there, edited
    ","created_time":"2021-01-13T19:22:32+0000","entities":[{"id":154613,"name":"Blah Ixigo","type":2},{"id":1,"name":"Ixigo","type":3}],"is_pinned":false}]}],"open_jobs":[{"candidates_hired":0,"candidates_submitted":0,"client_company_contacts":[],"department_name":"Engineering","id":1115,"job_visibility_id":1,"last_opened":"2021-01-04T10:02:18+0000","locations":[{"city":"Bangalore","country":"India","id":1,"iso_3166_1_alpha_2_code":"IN","name":"Bengaluru","postal_code":"560008","state":"Karnataka","zipcode":"560008"}],"name":"Senior Backend Developer"}],"phone_number":[],"pipeline":{"candidates_hired":1,"candidates_submitted":0},"revenue":{"currency":"USD","number":5000000},"status":{"id":null,"name":null},"subsidiary_companies":[],"tags":[]}],"total_items":1}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all client company in the account.","tags":["Client APIs"]}},"/api/external/client/notes/add":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"created_by":{"type":"integer"},"id":{"description":"id of the Contact.","type":"integer"},"mentions":{"items":{"type":"integer"},"type":"array"},"value":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"note_id":1}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Adds note to the specified client company","tags":["Client APIs"]}},"/api/external/client/search":{"post":{"description":"Link
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"conjunction":{"type":"string"},"current_page":{"type":"string"},"filters":{"items":{"properties":{"days":{"type":"string"},"filter_type":{"type":"string"},"is_relative":{"type":"boolean"},"key":{"type":"string"}},"type":"object"},"type":"array"},"items_per_page":{"type":"string"}},"required":["items_per_page","conjunction","current_page"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"count":2,"data":[{"added_by":{"id":3,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3/profile-picture.png","name":"zyz abc"},"added_time":"2021-01-15T05:46:01+0000","careers_page":"","company_size":"10,000+","custom_fields":[],"domain":"Facebook.com","id":5,"img_link":"None","industry":"Marketing And Advertising","jobs":[],"lead_owner":{"id":3,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3/profile-picture.png","name":"zyz abc"},"linkedin_page":"","location":{"city":"None","country":"None","location":"None","postal_code":"None","state":"None","street_address_1":"None","street_address_2":"None"},"name":"Groffers","phone_number":[],"revenue":{"currency":"USD","number":1212},"status":{"id":"None","name":"None"},"tags":[]},{"added_by":{"id":3,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3/profile-picture.png","name":"zyz abc"},"added_time":"2021-01-15T05:46:01+0000","careers_page":"","company_size":"10,000+","custom_fields":[],"domain":"Facebook.com","id":4,"img_link":"None","industry":"Marketing And Advertising","jobs":[],"lead_owner":{"id":3,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3/profile-picture.png","name":"zyz abc"},"linkedin_page":"","location":{"city":"None","country":"None","location":"None","postal_code":"None","state":"None","street_address_1":"None","street_address_2":"None"},"name":"Facebook","phone_number":[],"revenue":{"currency":"USD","number":"None"},"status":{"id":"None","name":"None"},"tags":[]}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Find all search types in the link below.","tags":["Client APIs"]}},"/api/external/client/status/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"id":1,"name":"Prospect"},{"id":2,"name":"Lead"},{"id":3,"name":"In Progress"},{"id":4,"name":"Won"},{"id":5,"name":"Lost"}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all Company statuses.","tags":["Client APIs"]}},"/api/external/client/update":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"id\" : 341,\n \"name\" : \"swagger company swagging\",\n \"phone_number\" : \"987689928\",\n \"linkedin_page\" : \"https://www.linkedin.com/in/abhishek-bachchan/\",\n \"careers_page\" : \"https://twitter.com/989fabd17d7341a\",\n \"domain\" : \"https://www.nutanix.com\",\n \"lead_owner_id\" : 1,\n \"added_by\" : 1,\n \"industry_id\" : 1,\n \"company_size\" : \"2\",\n \"subsidiary_company_ids\" : [1, 2],\n \"parent_company_id\" : 1,\n \"revenue\" : {\n \"currency\": \"USD\",\n \"number\": \"1000\"\n },\n \"location\" : {\n \"city\": \"Dallas\",\n \"country\": \"United States\",\n \"location\": \"Dallas, TX, USA\",\n \"postal_code\": \"\",\n \"state\": \"Texas\",\n \"street_address_1\": \"\",\n \"street_address_2\": \"\"\n },\n \"status_id\" : 3,\n \"tags\" : [\"swagger\"],\n \"custom_fields\" : [\n {\n \"id\" : 30,\n \"value\" : [\"Random\"]\n }\n ]\n}"}},"schema":{"properties":{"added_by":{"type":"integer"},"careers_page":{"type":"string"},"company_size":{"description":"acceptable values fetched from https://recruiterflow.com/api/external/company-size/list","type":"string"},"custom_fields":{"items":{"properties":{"id":{"type":"integer"},"value":{"items":{"type":"string"},"type":"array"}},"type":"object"},"type":"array"},"domain":{"type":"string"},"id":{"type":"integer"},"industry_id":{"type":"integer"},"lead_owner_id":{"type":"integer"},"linkedin_page":{"type":"string"},"location":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"location":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"},"street_address_1":{"type":"string"},"street_address_2":{"type":"string"}},"type":"object"},"name":{"type":"string"},"parent_company_id":{"type":"integer"},"phone_number":{"type":"string"},"revenue":{"properties":{"currency":{"type":"string"},"number":{"type":"string"}},"type":"object"},"status_id":{"type":"integer"},"subsidiary_company_ids":{"items":{"type":"integer"},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"}},"required":["id"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"RESULT":"SUCCESS"}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Updates existing client company details, including custom fields","tags":["Client APIs"]}},"/api/external/company-size/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":1,"name":"1-10"},{"id":2,"name":"11-50"},{"id":3,"name":"51-200"},{"id":4,"name":"201-500"},{"id":5,"name":"501-1000"},{"id":6,"name":"1001-5000"},{"id":7,"name":"5001-10,000"},{"id":8,"name":"10,000+"}],"total_items":8}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all company size.","tags":["Client APIs"]}},"/api/external/contact/activity-type/list":{"get":{"description":"Note: The keys \"track_last_contacted\" and \"track_last_engaged\" are used only for custom activity types.
    For default activity types, these keys will always be False.
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"category":"Communication","id":1,"is_archived":false,"is_custom":false,"name":"Note","rank":1,"track_last_contacted":false,"track_last_engaged":false},{"category":"Communication","id":2,"is_archived":false,"is_custom":false,"name":"Email","rank":2,"track_last_contacted":false,"track_last_engaged":false},{"category":"Job-related","id":3,"is_archived":false,"is_custom":false,"name":"Scorecard","rank":3,"track_last_contacted":false,"track_last_engaged":false},{"category":"Custom","id":1001,"is_archived":false,"is_custom":true,"name":"Lunch with candidate","rank":1001,"track_last_contacted":true,"track_last_engaged":true}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all activity types for contacts.","tags":["Contact APIs"]}},"/api/external/contact/activity/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Contact ID for which the activities are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"activity_id":1001,"associated_entities":{"candidates":[],"clients":[],"contacts":[{"id":955,"name":"Test Contact"}],"deals":[],"jobs":[]},"candidate_id":null,"contact_id":955,"interview_plan_id":null,"is_custom":1,"job_id":null,"subject":"System Admin logged an activity of type - CustomActivity01","text":"Test custom activity text","time":"2024-04-15T21:07:00+05:30","type":{"id":100,"name":"CustomActivity01"},"user":{"email":"test@testmail.com","first_name":"Michael","id":1,"last_name":"Scott","name":"Michael Scott"}}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get paginated list of activities for a contact.","tags":["Contact APIs"]}},"/api/external/contact/add":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"first_name\" : \"swagger\",\n \"last_name\" : \"contact\",\n \"email\" : [{\n \"email\": \"swagger@mail.com\",\n \"is_primary\" : 1\n }\n ],\n \"phone_number\" : [\n {\n \"phone_number\" : \"987689928\",\n \"type\" : 1\n }\n ],\n \"client_company\" : \"swagger company\",\n \"linkedin_profile\" : \"https://www.linkedin.com/in/abhishek-bachchan/\",\n \"twitter_profile\" : \"https://twitter.com/989fabd17d7341a\",\n \"facebook_profile\" : \"https://www.facebook.com/bikash.shaw.56884\",\n \"github_profile\" : \"https://github.com/bikashkumarshaw\",\n \"angellist_profile\" : \"https://angel.co/u/bikash-shaw-1\",\n \"tags\" : [\"swagger\"],\n \"skills\" : [\"swagger\"],\n \"title\" : \"swagger pos\",\n \"organization\" : \"swagger company\",\n \"source\" : \"linkedin\",\n \"custom_fields\" : [\n {\n \"id\" : 33,\n \"value\" : {\"currency\": \"USD\", \"number\": 600000}\n }\n ],\n \"experience\" : [\n {\"organization\":\"Facebook\",\n \"designation\":\"SDE\",\n \"from\":[\"2\",\"2021\"],\n \"to\":[\"2\",\"2021\"]\n }\n ],\n \"education\" : [\n {\"school\":\"HPCA\",\n \"degree\":\"10th\",\n \"specialization\": \"MATHS\",\n \"from\":[\"5\",\"2021\"],\n \"to\":[\"5\",\"2022\"]\n }\n ],\n \"added_time\" : \"2021-01-12T10:16:16+0000\"\n}"}},"schema":{"properties":{"added_time":{"type":"string"},"angellist_profile":{"type":"string"},"client_company":{"type":"string"},"custom_fields":{"items":{"properties":{"id":{"type":"integer"},"value":{"type":"object"}},"type":"object"},"type":"array"},"education":{"items":{"properties":{"degree":{"type":"string"},"from":{"items":"type:string","type":"array"},"school":{"type":"string"},"specialization":{"type":"string"},"to":{"items":"type:string","type":"array"}},"type":"object"},"type":"array"},"email":{"items":{"properties":{"email":{"type":"string"},"is_primary":{"type":"integer"}},"type":"object"},"type":"array"},"experience":{"items":{"properties":{"designation":{"type":"string"},"from":{"items":"type:string","type":"array"},"organization":{"type":"string"},"to":{"items":"type:string","type":"array"}},"type":"object"},"type":"array"},"facebook_profile":{"type":"string"},"first_name":{"type":"string"},"github_profile":{"type":"string"},"last_name":{"type":"string"},"linkedin_profile":{"type":"string"},"organization":{"type":"string"},"phone_number":{"items":{"properties":{"phone_number":{"type":"string"},"type":{"type":"integer"}},"type":"object"},"type":"array"},"skills":{"items":{"type":"string"},"type":"array"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"twitter_profile":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","data":{"id":154721}},"schema":{"properties":{"RESULT":{"type":"string"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"The contact endpoint allows you to add a contact to Recruiterflow.","tags":["Contact APIs"]}},"/api/external/contact/calendar-event/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Contact ID for which the tasks are needed.","example":157877,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"attachments":[],"attendees":[{"email":"tony.stark@avengers.com","name":"T Stark","status":null}],"calendar":{"calendar_id":"RANDOM_GOOGLE_CALENDAR","id":1,"name":"Google Calendar"},"description":"
    Will be tested on proficiency in saving the world!
    ","end_time":"2023-03-21T10:00:00+0000","entities":[{"id":25,"name":"Tony Stark","type":1}],"id":2,"interview":{},"organizer":{"email":"johndoe@example.com","name":"John Doe"},"start_time":"2023-03-21T09:00:00+0000","title":"Avenger: Technical Interview - I","user":{"email":"johndoe@example.com","first_name":"John","id":1,"last_name":"Doe"}},{"attachments":[],"attendees":[{"email":"tony.stark@avengers.com","name":"T Stark","status":null}],"calendar":{"calendar_id":"RANDOM_GOOGLE_CALENDAR","id":1,"name":"Google Calendar"},"description":"
    Will be tested on proficiency in saving the world!
    ","end_time":"2023-03-22T10:00:00+0000","entities":[{"id":25,"name":"Tony Stark","type":1}],"id":3,"interview":{},"organizer":{"email":"johndoe@example.com","name":"John Doe"},"start_time":"2023-03-22T09:00:00+0000","title":"Avenger: Technical Interview - II","user":{"email":"johndoe@example.com","first_name":"John","id":1,"last_name":"Doe"}},{"attachments":[],"attendees":[{"email":"tony.stark@avengers.com","name":"T Stark","status":null}],"calendar":{"calendar_id":"RANDOM_GOOGLE_CALENDAR","id":1,"name":"Google Calendar"},"description":"
    Will be tested on proficiency in saving the world!
    ","end_time":"2023-03-23T10:00:00+0000","entities":[{"id":25,"name":"Tony Stark","type":1}],"id":1,"interview":{},"organizer":{"email":"johndoe@example.com","name":"John Doe"},"start_time":"2023-03-23T09:00:00+0000","title":"Avenger: Practical Test","user":{"email":"johndoe@example.com","first_name":"John","id":1,"last_name":"Doe"}}],"total_items":3}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all calendar events for a contact","tags":["Contact APIs"]}},"/api/external/contact/calls/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Contact ID for which the calls are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"end_time":"2023-05-01T03:36:00+0000","entities":[{"id":22,"name":"Steve Rogers","type":"Candidate"}],"id":1,"meeting_type":"Meeting Type","notes":{"notes":"
    HI test call
    ","users":[]},"outcome":"Busy","start_time":"2023-05-01T02:36:00+0000","title":"Call Title","user":{"id":1,"name":"Tony Stark"}}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all calls list for a Contact","tags":["Contact APIs"]}},"/api/external/contact/custom-field/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":[{"choices":[{"id":855,"name":"Basic"},{"id":856,"name":"Moderate"},{"id":857,"name":"High"},{"id":858,"name":"Expert"}],"id":245,"name":"Proficiency","x":"single_select"}],"schema":{"items":{"properties":{"choices":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"type":"array"},"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"The endpoint lists all contact custom fields.","tags":["Contact APIs"]}},"/api/external/contact/emails/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Contact ID for which the calls are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"gmail_thread_id":"dsflads2378r23nfdkjs","id":1,"messages":[{"attachments":[],"body":"
    Test email
    ","cc":[],"from":"Tony Stark ","from_initials":"T","from_name":"Tony Stark","gmail_message_id":"sdf32q0239ew12321","id":1,"opens":[],"sender":{"email":"tony.stark@recruiterflow.com","message_id":1,"name":"Tony Stark"},"sent":"2022-08-01T09:00:00+0000","subject":"Thanos is coming, we need you!","to":[{"email":"captain.america@avengers.com","message_id":1,"name":""}]}]}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all emails list for a Contact","tags":["Contact APIs"]}},"/api/external/contact/file/add":{"post":{"description":"If file is being added by url, file_name is mandatory
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file_name":{"type":"string"},"files":{"format":"binary","type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","data":{"num_files":3}},"schema":{"properties":{"RESULT":{"type":"string"},"data":{"properties":{"num_files":{"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Please add ARGUMENTS (AS A FORM), the api is used to attach files to contacts.","tags":["Contact APIs"]}},"/api/external/contact/get":{"get":{"parameters":[{"description":"Prospect id you want to fetch.","example":10,"explode":true,"in":"query","name":"id","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"added_by":{"email":"admin@recruiterflow.com","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","name":"System Admin"},"angellist_profile":null,"attributes":[],"behance_profile":null,"campaigns":[],"client":{"added_by":{"email":"admin@recruiterflow.com","id":3264,"name":"System Admin"},"added_time":null,"careers_page":"https://www.ixigo.com/about/careers/","closed_jobs":[{"candidates_hired":0,"candidates_submitted":0,"client_company_contacts":[],"department_name":"Engineering","id":91,"job_visibility_id":6,"last_opened":"2020-10-01T05:49:51+0000","locations":[{"city":"Kolkata","country":"India","id":13,"iso_3166_1_alpha_2_code":"IN","name":"Test","postal_code":"700036","state":"West bengal","zipcode":"700036"}],"name":"New Job Pipeline"}],"company_size":3,"company_size_name":"51-200","complete_address":"Golf Course Road, DLF Phase 5, Sector 53, Gurugram, Haryana, India, 122002","contacts":[{"designation":null,"id":154613,"img_link":null,"is_primary":false,"name":"Blah Ixigo"}],"custom_fields":[{"id":43,"name":"Close By","rank":5,"unique_key":"close-by","value":[{"currency":null,"date_value":"2020-04-16","department":null,"id":2737,"long_text":null,"multi_select":null,"multi_select_name":null,"number1_value":null,"number2_value":null,"number_value":null,"rich_text":null,"short_text":null,"single_select":null,"single_select_name":null,"user":null,"yes_no":null}],"view_field_id":6}],"domain":"gmail.com","files":[],"followers":[],"id":1,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/client-company-logos/prod/client/db_b18c893c749e320e66fbb2f7fef6b1be/1/logo.png","industry_id":13,"industry_name":"Internet","jobs":[{"candidates_hired":0,"candidates_submitted":0,"client_company_contacts":[],"department_name":"Engineering","id":91,"job_visibility_id":6,"last_opened":"2020-10-01T05:49:51+0000","locations":[{"city":"Kolkata","country":"India","id":13,"iso_3166_1_alpha_2_code":"IN","name":"Test","postal_code":"700036","state":"West bengal","zipcode":"700036"}],"name":"New Job Pipeline"}],"lead_owner":{"email":"admin@recruiterflow.com","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","name":"System Admin"},"linkedin_page":"","location":{"city":"Gurugram","country":"India","google_place_id":"ChIJLVyTdrQYDTkRrzz-1CTXg_M","latitude":null,"location":"ixigo, Golf Course Road, Parsvnath Exotica, DLF Phase 5, Sector 53, Gurugram, Haryana, India","longitude":null,"postal_code":"122002","state":"Haryana","street_address_1":"Golf Course Road","street_address_2":"DLF Phase 5, Sector 53"},"name":"Ixigo","open_jobs":[{"candidates_hired":0,"candidates_submitted":0,"client_company_contacts":[],"department_name":"Engineering","id":1115,"job_visibility_id":1,"last_opened":"2021-01-04T10:02:18+0000","locations":[{"city":"Bangalore","country":"India","id":1,"iso_3166_1_alpha_2_code":"IN","name":"Bengaluru","postal_code":"560008","state":"Karnataka","zipcode":"700036"}],"name":"Senior Backend Developer"}],"phone_number":[],"pipeline":{"candidates_hired":1,"candidates_submitted":0},"revenue":{"currency":"USD","number":5000000},"status":{"id":null,"name":null},"subsidiary_companies":[],"tags":[]},"client_company_id":1,"client_company_name":"Ixigo","current_designation":null,"custom_fields":[],"do_not_email":false,"dribbble_profile":null,"education":[],"email":["blah@ixigo.com"],"entity_status_id":null,"experience":[],"facebook_profile":null,"files":[],"first_name":"Blah","followers":[],"github_profile":null,"id":154613,"img_link":null,"jobs":[],"last_contact_type":null,"last_contacted":null,"last_engaged":null,"last_engagement_type":null,"last_name":"Ixigo","last_updated":"2021-01-12T10:16:16+0000","lead_owner":{"email":"admin@recruiterflow.com","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","name":"System Admin"},"lead_owner_name":"System Admin","linkedin_profile":null,"location":{"city":null,"country":null,"google_place_id":null,"latitude":null,"location":null,"longitude":null,"postal_code":null,"postal_code_id":null,"state":null,"street_address_1":null,"street_address_2":null},"name":"Blah Ixigo","notes":[{"author":{"email":"admin@recruiterflow.com","first_name":"System","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","last_name":"Admin","name":"System Admin"},"author_email":"admin@recruiterflow.com","author_first_name":"System","author_img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","author_last_name":"Admin","content":"
    @Naresh Shenoy How are you doing?
    ","created_time":"2021-01-13T19:20:10+0000","entities":[{"id":154613,"name":"Blah Ixigo","type":2},{"id":1,"name":"Ixigo","type":3}],"id":10,"is_pinned":false,"replies":[{"author":{"email":"admin@recruiterflow.com","first_name":"System","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","last_name":"Admin","name":"System Admin"},"author_email":"admin@recruiterflow.com","author_first_name":"System","author_img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","author_last_name":"Admin","content":"
    @System Admin Hi there, edited
    ","created_time":"2021-01-13T19:22:32+0000","entities":[{"id":154613,"name":"Blah Ixigo","type":2},{"id":1,"name":"Ixigo","type":3}],"is_pinned":false}]}],"other_profiles":{"result":false},"phone_number":[],"prospect_campaign_id":null,"prospect_channel_id":null,"prospect_id":154613,"prospect_medium_id":null,"prospect_type_id":2,"skills":[],"source":null,"source_id":null,"status":{"id":null,"name":null},"tags":[],"twitter_profile":null,"xing_profile":null}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Returns the contacts info for the specified id.","tags":["Contact APIs"]}},"/api/external/contact/list":{"get":{"parameters":[{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Include contact files in response, defaults to False.","example":0,"explode":true,"in":"query","name":"include_files","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Include contact notes in response, defaults to False.","example":1,"explode":true,"in":"query","name":"include_notes","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"added_by":{"id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","name":"System Admin"},"added_time":"2021-01-12T10:16:16+0000","angellist_profile":null,"behance_profile":null,"client":null,"client_company_id":1,"client_company_name":"Ixigo","current_designation":null,"custom_fields":[],"do_not_email":false,"dribbble_profile":null,"email":["blah@ixigo.com"],"experience":[],"facebook_profile":null,"files":[],"first_name":"Blah","github_profile":null,"id":154613,"img_link":null,"jobs":[],"last_contact_type":null,"last_contacted":null,"last_engaged":null,"last_engagement_type":null,"last_name":"Ixigo","latest_activity_time":"2021-01-13T19:22:32+0000","lead_owner":{"id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","name":"System Admin"},"linkedin_profile":null,"location":{"city":null,"country":null,"google_place_id":null,"location":null,"postal_code":null,"state":null,"street_address_1":null,"street_address_2":null},"name":"Blah Ixigo","notes":[{"author":{"email":"admin@recruiterflow.com","first_name":"System","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","last_name":"Admin","name":"System Admin"},"author_email":"admin@recruiterflow.com","author_first_name":"System","author_img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","author_last_name":"Admin","content":"
    @Naresh Shenoy How are you doing?
    ","created_time":"2021-01-13T19:20:10+0000","entities":[{"id":154613,"name":"Blah Ixigo","type":2},{"id":1,"name":"Ixigo","type":3}],"id":10,"is_pinned":false,"replies":[{"author":{"email":"admin@recruiterflow.com","first_name":"System","id":3264,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","last_name":"Admin","name":"System Admin"},"author_email":"admin@recruiterflow.com","author_first_name":"System","author_img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/3264/profile-picture.png","author_last_name":"Admin","content":"
    @System Admin Hi there, edited
    ","created_time":"2021-01-13T19:22:32+0000","entities":[{"id":154613,"name":"Blah Ixigo","type":2},{"id":1,"name":"Ixigo","type":3}],"is_pinned":false}]}],"phone_number":[],"prospect_id":154613,"prospect_type_id":2,"source_name":null,"status":{"id":null,"name":null},"submission_times":[],"tags":[],"twitter_profile":null,"upcoming_activities":{},"xing_profile":null}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all contacts and their details.","tags":["Contact APIs"]}},"/api/external/contact/notes/add":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"note_id":1},"schema":{"properties":{"created_by":{"type":"integer"},"id":{"description":"id of the Contact.","type":"integer"},"mentions":{"items":{"type":"integer"},"type":"array"},"value":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Auto generated using Swagger Inspector"}},"summary":"The endpoint adds notes to the specified contact.","tags":["Contact APIs"]}},"/api/external/contact/profile-image/upload":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Contact ID for which the image is being updated","example":157877,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Content of the profile image in base64-encoded format","example":"abcdef==","explode":false,"in":"query","name":"img","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"File name of the profile image","example":"profile-picture.png","explode":false,"in":"query","name":"filename","required":false,"schema":{"type":"string"},"style":"simple"}],"summary":"Update profile picture for a contact","tags":["Contact APIs"]}},"/api/external/contact/search":{"post":{"description":"Link

    Note: Structure changes to {\"data\": [], \"total_items\": int} when include_count is enabled.

    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"items_per_page\": 20,\n \"conjunction\": \"match-all\", \n \"filters\": [\n {\n \"filter_type\": \"less-than\", \n \"is_relative\": true, \n \"key\": \"last_activity\", \n \"name\": \"Last activity\", \n \"rank\": 900,\n \"status\": \"COMPLETE\",\n \"text\": \"less than 10 days ago\",\n \"type\": \"date\",\n \"days\": 10\n }\n ], \n \"current_page\": 1,\n \"include_count\": true\n}"},"1":{"value":"{\n \"conjunction\": \"match-all\", \n \"current_page\": 1, \n \"filters\": [\n {\n \"filter_type\": \"less-than\", \n \"is_relative\": true, \n \"key\": \"last_activity\", \n \"name\": \"Last activity\", \n \"rank\": 1050,\n \"status\": \"COMPLETE\",\n \"text\": \"less than 10 days ago\",\n \"type\": \"date\",\n \"days\": 10\n }\n ], \n \"items_per_page\": 20\n}"}},"schema":{"properties":{"conjunction":{"type":"string"},"current_page":{"type":"string"},"filters":{"items":{"properties":{"days":{"type":"string"},"filter_type":{"type":"string"},"include_calls":{"type":"boolean"},"include_custom_activities":{"type":"boolean"},"include_emails":{"type":"boolean"},"include_texts":{"type":"boolean"},"is_relative":{"type":"boolean"},"key":{"type":"string"}},"type":"object"},"type":"array"},"include_count":{"type":"boolean"},"items_per_page":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"data":[{"added_by":{"id":14494,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/14494/profile-picture.png","name":"Shreyas Savanoor"},"added_time":"2020-10-22T09:45:31+0000","angellist_profile":"None","behance_profile":"None","client":"None","client_company_id":4,"client_company_name":"Akpe","current_designation":"None","current_organization":"None","custom_fields":[],"do_not_email":false,"dribbble_profile":"None","email":[{"email":"shreyas.savanoor@gmail.com","is_primary":true}],"facebook_profile":"None","first_name":"shreyas_contact","github_profile":"None","id":153614,"img_link":"None","jobs":[],"last_contact_type":1,"last_contacted":"2020-11-06T07:36:21+0000","last_engaged":"None","last_engagement_type":"None","last_name":"","latest_activity_time":"None","lead_owner":{"id":2854,"img_link":"None","name":"System User"},"linkedin_profile":"None","location":{"city":"","country":"","google_place_id":"","location":"","postal_code":"","state":"","street_address_1":"","street_address_2":""},"name":"shreyas_contact","phone_number":[],"prospect_id":153614,"prospect_type_id":2,"source_name":"None","status":{"id":"None","name":"None"},"submission_times":[],"tags":["Java","angular","another tag"],"twitter_profile":"None","upcoming_activities":{},"xing_profile":"None"}],"rank":{},"total_items":6}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Find all search types in the link below.","tags":["Contact APIs"]}},"/api/external/contact/status/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"id":1,"name":"New"},{"id":2,"name":"In Progress"},{"id":3,"name":"Closed"}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"List all statuses for contacts.","tags":["Contact APIs"]}},"/api/external/contact/task/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Contact ID for which the tasks are needed.","example":157877,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"assignees":[{"email":"johndoe@example.com","first_name":"John","id":1,"last_name":"Doe","name":"John Doe"}],"created_by":{"email":"johndoe@example.com","id":1,"name":"johndoe@example.com"},"due_date":"2023-03-29T03:30:00+0000","entered_due_date":"2023-03-29T09:00:00+0000","entered_reminder_time":"2023-03-29T09:00:00+05:30","entities":[{"id":25,"name":"Tony Stark","type":1}],"id":1,"is_over_due":true,"name":"test task","notes":"
    test task
    ","prospects":[],"reminder_time":"2023-03-29T03:30:00+0000","task_status":"Open","task_type":"Email"},{"assignees":[{"email":"johndoe@example.com","first_name":"John","id":1,"last_name":"Doe","name":"John Doe"}],"created_by":{"email":"johndoe@example.com","id":1,"name":"John Doe"},"due_date":"2023-03-29T03:30:00+0000","entered_due_date":"2023-03-29T09:00:00+0000","entered_reminder_time":"2023-03-29T09:00:00+05:30","entities":[{"id":25,"name":"Tony Stark","type":1}],"id":2,"is_over_due":true,"name":"test task 1","notes":"
    test task 1
    ","prospects":[],"reminder_time":"2023-03-29T03:30:00+0000","task_status":"Open","task_type":"Email"},{"assignees":[{"email":"johndoe@example.com","first_name":"John","id":1,"last_name":"Doe","name":"John Doe"}],"created_by":{"email":"johndoe@example.com","id":1,"name":"John Doe"},"due_date":"2023-03-29T03:30:00+0000","entered_due_date":"2023-03-29T09:00:00+0000","entered_reminder_time":"2023-03-29T09:00:00+05:30","entities":[{"id":25,"name":"Tony Stark","type":2}],"id":3,"is_over_due":true,"name":"test task 2","notes":"
    test task 3
    ","prospects":[],"reminder_time":"2023-03-29T03:30:00+0000","task_status":"Open","task_type":"Email"}],"total_items":3}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all tasks for a candidate","tags":["Contact APIs"]}},"/api/external/contact/update":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"name\" : \"swagger contact\",\n \"first_name\" : \"swagger\",\n \"last_name\" : \"contact\",\n \"email\" : [{\n \"email\": \"swagger@mail.com\",\n \"is_primary\" : 1\n }\n ],\n \"id\" : 5157,\n \"client_company\" : \"swagger company\",\n \"phone_number\" : [\n {\n \"phone_number\" : \"987689928\",\n \"type\" : 1\n }\n ],\n \"linkedin_profile\" : \"https://www.linkedin.com/in/abhishek-bachchan/\",\n \"twitter_profile\" : \"https://twitter.com/989fabd17d7341a\",\n \"facebook_profile\" : \"https://www.facebook.com/bikash.shaw.56884\",\n \"github_profile\" : \"https://github.com/bikashkumarshaw\",\n \"angellist_profile\" : \"https://angel.co/u/bikash-shaw-1\",\n \"tags\" : [\"swagger\"],\n \"skills\" : [\"swagger\"],\n \"title\" : \"swagger pos\",\n \"organization\" : \"swagger company\",\n \"source\" : \"linkedin\",\n \"custom_fields\" : [\n {\n \"id\" : 33,\n \"value\" : {\"currency\": \"USD\", \"number\": 600000}\n }\n ],\n \"experience\" : [\n {\"organization\":\"Facebook\",\n \"designation\":\"SDE\",\n \"from\":[\"2\",\"2021\"],\n \"to\":[\"2\",\"2021\"]\n }\n ],\n \"education\" : [\n {\"school\":\"HPCA\",\n \"degree\":\"10th\",\n \"specialization\": \"MATHS\",\n \"from\":[\"5\",\"2021\"],\n \"to\":[\"5\",\"2022\"]\n }\n ]\n}"}},"schema":{"properties":{"angellist_profile":{"type":"string"},"client_company":{"type":"string"},"custom_fields":{"items":{"properties":{"id":{"type":"integer"},"value":{"type":"object"}},"type":"object"},"type":"array"},"education":{"items":{"properties":{"degree":{"type":"string"},"from":{"items":"type:string","type":"array"},"school":{"type":"string"},"specialization":{"type":"string"},"to":{"items":"type:string","type":"array"}},"type":"object"},"type":"array"},"email":{"items":{"properties":{"email":{"type":"string"},"is_primary":{"type":"integer"}},"type":"object"},"type":"array"},"experience":{"items":{"properties":{"designation":{"type":"string"},"from":{"items":"type:string","type":"array"},"organization":{"type":"string"},"to":{"items":"type:string","type":"array"}},"type":"object"},"type":"array"},"facebook_profile":{"type":"string"},"github_profile":{"type":"string"},"id":{"type":"integer"},"linkedin_profile":{"type":"string"},"name":{"type":"string"},"organization":{"type":"string"},"phone_number":{"items":{"properties":{"phone_number":{"type":"string"},"type":{"type":"integer"}},"type":"object"},"type":"array"},"skills":{"items":{"type":"string"},"type":"array"},"source":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"twitter_profile":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS"},"schema":{"properties":{"RESULT":{"type":"string"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"This API implements a complete update which means that any existing data in the provided key will be wiped out and replaced with the data provided, in case a key is not provided no update happens to it.","tags":["Contact APIs"]}},"/api/external/custom-activity/create":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"activity_text":{"description":"The text describing the activity.","example":"This is a test activity.","type":"string"},"activity_time":{"description":"The time of the activity in ISO format.","example":"2021-05-01T10:30:00+0000","type":"string"},"activity_type_id":{"description":"The id of the activity type.","type":"integer"},"activity_user_id":{"description":"The id of the user who performed the activity.","type":"integer"},"associated_entities":{"description":"The associated entities for the activity.","properties":{"candidates":{"description":"The list of candidate ids associated with the activity.","items":{"type":"integer"},"type":"array"},"clients":{"description":"The list of client ids associated with the activity.","items":{"type":"integer"},"type":"array"},"contacts":{"description":"The list of contact ids associated with the activity.","items":{"type":"integer"},"type":"array"},"deals":{"description":"The list of deal ids associated with the activity.","items":{"type":"integer"},"type":"array"},"jobs":{"description":"The list of job ids associated with the activity.","items":{"type":"integer"},"type":"array"}},"type":"object"},"mentions":{"description":"The list of mentions for the activity.","items":{"properties":{"id":{"description":"The id of the mentioned entity (user or team).","type":"integer"},"type":{"description":"The type of mention (1 for user, 2 for team).","type":"integer"},"value":{"description":"The name/value of the mentioned entity.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","data":{"activity_id":1234}}}},"description":"Auto generated using Swagger Inspector"},"400":{"content":{"application/json":{"example":{"RESULT":"FAILURE","message":"Invalid activity type id."}}},"description":"Auto generated using Swagger Inspector"},"404":{"content":{"application/json":{"example":{"RESULT":"FAILURE","message":"Invalid activity type id."}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Create a custom activity.","tags":["Other APIs"]}},"/api/external/custom-activity/delete":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"activity_id":{"description":"The id of the activity to be deleted.","type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","data":{"activity_id":1234}}}},"description":"Auto generated using Swagger Inspector"},"400":{"content":{"application/json":{"example":{"RESULT":"FAILURE","message":"Invalid activity id."}}},"description":"Auto generated using Swagger Inspector"},"404":{"content":{"application/json":{"example":{"RESULT":"FAILURE","message":"Invalid activity id."}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Delete a custom activity.","tags":["Other APIs"]}},"/api/external/custom-activity/update":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"activity_id":{"description":"The id of the activity to be updated.","type":"integer"},"activity_text":{"description":"The text describing the activity.","example":"This is a test activity.","type":"string"},"activity_time":{"description":"The time of the activity in ISO format.","example":"2021-05-01T10:30:00+0000","type":"string"},"activity_type_id":{"description":"The id of the activity type.","type":"integer"},"activity_user_id":{"description":"The id of the user who performed the activity.","type":"integer"},"associated_entities":{"description":"The associated entities for the activity.","properties":{"candidates":{"description":"The list of candidate ids associated with the activity.","items":{"type":"integer"},"type":"array"},"clients":{"description":"The list of client ids associated with the activity.","items":{"type":"integer"},"type":"array"},"contacts":{"description":"The list of contact ids associated with the activity.","items":{"type":"integer"},"type":"array"},"deals":{"description":"The list of deal ids associated with the activity.","items":{"type":"integer"},"type":"array"},"jobs":{"description":"The list of job ids associated with the activity.","items":{"type":"integer"},"type":"array"}},"type":"object"},"mentions":{"description":"The list of mentions for the activity.","items":{"properties":{"id":{"description":"The id of the mentioned entity (user or team).","type":"integer"},"type":{"description":"The type of mention (1 for user, 2 for team).","type":"integer"},"value":{"description":"The name/value of the mentioned entity.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","data":{"activity_id":1234}}}},"description":"Auto generated using Swagger Inspector"},"400":{"content":{"application/json":{"example":{"RESULT":"FAILURE","message":"Invalid activity type id."}}},"description":"Auto generated using Swagger Inspector"},"404":{"content":{"application/json":{"example":{"RESULT":"FAILURE","message":"Invalid activity type id."}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Update a custom activity.","tags":["Other APIs"]}},"/api/external/deal/activity-type/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"category":"Communication","id":1,"is_archived":false,"is_custom":false,"name":"Note","rank":1},{"category":"Communication","id":2,"is_archived":false,"is_custom":false,"name":"Email","rank":2},{"category":"Job-related","id":3,"is_archived":false,"is_custom":false,"name":"Scorecard","rank":3},{"category":"Custom","id":1001,"is_archived":false,"is_custom":true,"name":"Lunch with candidate","rank":1001}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all activity types for deal.","tags":["Deal APIs"]}},"/api/external/deal/activity/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Deal ID for which the activities are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"activity_id":1234,"associated_entities":{"candidates":[{"id":111,"name":"Test Candidate"}],"clients":[{"id":12,"name":"Test client company"}],"contacts":[],"deals":[],"jobs":[{"id":25,"name":"Test new job"}]},"candidate_id":null,"contact_id":null,"interview_plan_id":null,"is_custom":false,"job_id":null,"subject":"Michael Scott moved Test Candidate to Company Submission","text":"","time":"2021-10-10T11:15:00+05:30","type":{"id":39,"name":"Candidates submitted"},"user":{"email":"testemail@testdomain.com","first_name":"Michael","id":1,"last_name":"Scott","name":"Michael Scott"}}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get paginated list of activities for a deal.","tags":["Deal APIs"]}},"/api/external/deal/calls/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Deal ID for which the calls are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"end_time":"2023-05-01T03:36:00+0000","entities":[{"id":22,"name":"Test deal","type":"Deal"}],"id":1,"meeting_type":"Meeting Type","notes":{"notes":"
    HI test call
    ","users":[]},"outcome":"Busy","start_time":"2023-05-01T02:36:00+0000","title":"Call Title","user":{"id":1,"name":"Tony Stark"}}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all calls list for a deal","tags":["Deal APIs"]}},"/api/external/deal/create":{"post":{"description":"
    Please find the format of custom field input below.
  • Single select:
    {
    \"id\": single_select_cf_id,
    \"value\": \"string\"
    }


  • Multi select :
    {
    \"id\": multi_select_cf_id,
    \"value\": [\"string1\", \"string2\"]
    }


  • Short/Long text:
    {
    \"id\": short_text_cf_id,
    \"value\": \"text\"
    }


  • Money:
    {
    \"id\": money custom field id,
    \"value\": {\"number\": Integer(The amount), \"currency\": \"string(Currency code eg. USD, GBP)\"}
    }

  • Money Range:
    {
    \"id\": money reange custom field id,
    \"value\": {\"number1\": Integer(Starting Amount), \"number2\": \"Ending Amount\", \"currency\": \"string(Currency code eg. USD, GBP)\"}
    }

  • Number/Date:
    {
    \"id\": cf_id,
    \"value\": number/date to store
    }


  • Yes No:
    {
    \"id\": yes_no_cf_id,
    \"value\": 0 for No and 1 for Yes
    }


  • Profile :
    {
    \"id\": profile_cf_id,
    \"value\": [{\"id\": profile_id, \"type\": entity_type(Candidate, Contact, Company)}]
    }


  • Parent-Child :
    {
    \"id\": parent-child-cf-id,
    \"value\": [{\"name\": \"parent_name\", \"children\": [\"child1\", \"child2\"]}]
    }


  • Users :
    {
    \"id\": users_cf_id,
    \"value\": [integer_user_id_1, integer_user_id_1]
    }

    • ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"name\" : \"Deal 1\",\n \"amount_currency\": \"USD\",\n \"amount\": 1000,\n \"stage_id\": 6,\n \"user_id\": 1,\n \"close_date\": \"2023-01-01\",\n \"expected_close_date\": \"2023-01-01\",\n \"client_company\": \"X.Y.Z\",\n \"won_reason\": [\"Candidate Selected\"],\n \"lost_reason\": null,\n \"deal_owner_id\": 1,\n \"entities\":[\n {\n \"id\":260,\n \"type\":2 (Entities only supports Contacts, which is type=2)\n }\n ],\n \"custom_fields\": [\n {\n \"id\":2,\n \"value\":\"This deal is a test.\"\n }\n ]\n} "}},"schema":{"properties":{"amount":{"description":"Amount associated with the Deal.","type":"integer"},"amount_currency":{"description":"Currency of Amount.(Must be 3 letter iso codes. e.g \"USD\", \"AUD\")","type":"string"},"client_company":{"description":"Name of the Company associated with the Deal.","type":"string"},"close_date":{"description":"Deal close date in format YYYY-MM-DD. (Required only if moving to stage CLOSED LOST or CLOSED WON)","type":"string"},"custom_fields":{"items":{"properties":{"id":{"type":"integer"},"value":{"items":{"properties":{"id":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"deal_owner_id":{"description":"Owner ID associated with the Deal.","type":"integer"},"entities":{"items":{"properties":{"id":{"type":"integer"},"type":{"type":"integer"}},"type":"object"},"type":"array"},"expected_close_date":{"description":"Deal expected close date in format YYYY-MM-DD.","type":"string"},"lost_reason":{"items":{"description":"Required only if moving to stage CLOSED LOST.","type":"string"},"type":"array"},"name":{"description":"Name of the Deal.","type":"string"},"stage_id":{"description":"Stage ID associated with the Deal.","type":"integer"},"user_id":{"description":"ID of a User moving the Stage.","type":"integer"},"won_reason":{"items":{"description":"Required only if moving to stage CLOSED WON.","type":"string"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","id":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Create a New Deal.","tags":["Deal APIs"]}},"/api/external/deal/custom-field/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":65,"name":"DealCFDate","type":"date"},{"id":64,"name":"Number field","type":"number"},{"choices":[{"children":[],"id":8,"name":"choice1"},{"children":[],"id":8,"name":"choice2"}],"id":52,"name":"Single Select Field","type":"single_select"}],"total_items":3}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all Deal custom fields available.","tags":["Deal APIs"]}},"/api/external/deal/file/add":{"post":{"description":"If file is being added by url, file_name is mandatory
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file_name":{"type":"string"},"files":{"format":"binary","type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","data":{"num_files":3}},"schema":{"properties":{"RESULT":{"type":"string"},"data":{"properties":{"num_files":{"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Please add ARGUMENTS (AS A FORM), the api is used to attach files to deals.","tags":["Deal APIs"]}},"/api/external/deal/get":{"get":{"parameters":[{"description":"Deal id you want to fetch.","example":10,"explode":true,"in":"query","name":"id","required":false,"schema":{"type":"string"},"style":"form"},{"description":"User ID fetching deal.","example":10,"explode":true,"in":"query","name":"user_id","required":true,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"amount":10000,"amount_currency":"USD","client_company":{"id":1,"img_link":null,"name":"X.Y.Z."},"close_date":"2023-03-23","closed_reasons":{"lost_reason_ids":null,"won_reason_ids":[3]},"current_stage":{"id":6,"moved_time":"2023-02-28T22:55:51+0000","name":"Closed won","percentage":100,"rank":6},"custom_fields":[],"deal_owner":{"id":1,"name":"ABC"},"entities":[],"expected_close_date":"2023-03-23","files":[],"followers":[],"id":1,"name":"test","pipeline":{"id":1,"name":"Default pipeline"}}},"schema":{"properties":{"data":{"items":{"properties":{"amount":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"},"pipeline":{"properties":{"id":null,"name":{"type":"string"},"type":"integer"},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get details of a particular deal.","tags":["Deal APIs"]}},"/api/external/deal/list-stages":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"id":1,"name":"Default pipeline","stages":[{"id":1,"name":"Appointment scheduled","percentage":20,"rank":1},{"id":2,"name":"Qualified to buy","percentage":40,"rank":2},{"id":3,"name":"Client Pitch","percentage":60,"rank":3},{"id":4,"name":"Decision Maker Bought-In","percentage":80,"rank":4},{"id":5,"name":"Contract sent","percentage":90,"rank":5},{"id":6,"name":"Closed won","percentage":100,"rank":6},{"id":7,"name":"Closed lost","percentage":0,"rank":7}]}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all stages for deal pipeline","tags":["Deal APIs"]}},"/api/external/deal/move-stage":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"id\": 6,\n \"user_id\": 1,\n \"close_date\": \"2023-01-01\",\n \"expected_close_date\": \"2023-01-01\",\n \"won_reason\": [\"Candidate Selected\"],\n \"lost_reason\": null,\n \"to_stage\": {\n \"id\": 1,\n \"name\": \"Client Pitch\"\n }\n} "}},"schema":{"properties":{"close_date":{"description":"Deal close date in format YYYY-MM-DD. (Required only if moving to stage CLOSED LOST or CLOSED WON)","type":"string"},"expected_close_date":{"description":"Deal expected close date in format YYYY-MM-DD.","type":"string"},"id":{"description":"Deal ID","type":"integer"},"lost_reason":{"items":{"type":"string(Required only if moving to stage CLOSED LOST)"},"type":"array"},"to_stage":{"properties":{"id":{"description":"Stage ID of the destination stage.(You can send either Stage ID or Stage Name.)","type":"integer"},"name":{"description":"Stage name of the destination stage.(You can send either Stage ID or Stage Name.)","type":"string"}},"type":"object"},"user_id":{"description":"ID of a User moving the Stage.","type":"integer"},"won_reason":{"items":{"type":"string(Required only if moving to stage CLOSED WON)"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Move a deal to a new stage","tags":["Deal APIs"]}},"/api/external/deal/search":{"post":{"description":"Link
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"conjunction":{"type":"string"},"current_page":{"type":"string"},"filters":{"items":{"properties":{"days":{"type":"string"},"filter_type":{"type":"string"},"is_relative":{"type":"boolean"},"key":{"type":"string"}},"type":"object"},"type":"array"},"items_per_page":{"type":"string"}},"required":["items_per_page","conjunction","current_page"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"count":1,"data":[{"amount":null,"amount_currency":null,"client_company":{"id":2,"img_link":null,"name":"company"},"close_date":"2023-06-08","current_stage":{"id":1,"moved_time":"2023-05-08T09:42:49+0000","name":"Appointment scheduled","percentage":20,"rank":1},"custom_fields":[],"deal_owner":{"id":1,"name":"Tripti Singh"},"expected_close_date":"2023-06-08","id":1,"name":"test deal","pipeline":{"id":1,"name":"Default pipeline"}}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Find all search types in the link below.","tags":["Deal APIs"]}},"/api/external/deal/update":{"post":{"description":"
    Please find the format of custom field input below.
  • Single select:
    {
    \"id\": single_select_cf_id,
    \"value\": \"string\"
    }


  • Multi select :
    {
    \"id\": multi_select_cf_id,
    \"value\": [\"string1\", \"string2\"]
    }


  • Short/Long text:
    {
    \"id\": short_text_cf_id,
    \"value\": \"text\"
    }


  • Money:
    {
    \"id\": money custom field id,
    \"value\": {\"number\": Integer(The amount), \"currency\": \"string(Currency code eg. USD, GBP)\"}
    }

  • Money Range:
    {
    \"id\": money reange custom field id,
    \"value\": {\"number1\": Integer(Starting Amount), \"number2\": \"Ending Amount\", \"currency\": \"string(Currency code eg. USD, GBP)\"}
    }

  • Number/Date:
    {
    \"id\": cf_id,
    \"value\": number/date to store
    }


  • Yes No:
    {
    \"id\": yes_no_cf_id,
    \"value\": 0 for No and 1 for Yes
    }


  • Profile :
    {
    \"id\": profile_cf_id,
    \"value\": [{\"id\": profile_id, \"type\": entity_type(Candidate, Contact, Company)}]
    }


  • Parent-Child :
    {
    \"id\": parent-child-cf-id,
    \"value\": [{\"name\": \"parent_name\", \"children\": [\"child1\", \"child2\"]}]
    }


  • Users :
    {
    \"id\": users_cf_id,
    \"value\": [integer_user_id_1, integer_user_id_1]
    }

    • ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{ \n \"id\": 1,\n \"name\" : \"Test Deal\",\n \"amount_currency\": \"USD\",\n \"amount\": 1000,\n \"stage_id\": 7,\n \"stage_name\": \"CLIENT PITCH\"\n \"user_id\": 1,\n \"close_date\": \"2023-01-01\",\n \"expected_close_date\": \"2023-01-01\",\n \"client_company\": \"X.Y.Z\",\n \"won_reason\": null,\n \"lost_reason\": [\"Candidate Rejected\"],\n \"deal_owner_id\": 1,\n \"entities\":[\n {\n \"id\":26,\n \"name\":\"Test\",\n \"type\":2\n }\n ],\n \"custom_fields\": [\n {\n \"id\":2,\n \"value\":\"This deal is a test.\"\n }\n ]\n} "}},"schema":{"properties":{"amount":{"description":"Amount associated with the Deal.","type":"integer"},"amount_currency":{"description":"Currency of Amount.(Must be 3 letter iso codes. e.g \"USD\", \"AUD\")","type":"string"},"client_company":{"description":"Name of the Company associated with the Deal.","type":"string"},"close_date":{"description":"Deal close date in format YYYY-MM-DD. (Required only if moving to stage CLOSED LOST or CLOSED WON)","type":"string"},"custom_fields":{"items":{"properties":{"id":{"type":"integer"},"value":{"items":{"properties":{"id":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"deal_owner_id":{"description":"Owner ID associated with the Deal.","type":"integer"},"entities":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"}},"type":"object"},"type":"array"},"expected_close_date":{"description":"Deal expected close date in format YYYY-MM-DD.","type":"string"},"id":{"description":"ID of a Deal to update.","type":"integer"},"lost_reason":{"items":{"type":"string(Required only if moving to stage CLOSED LOST)"},"type":"array"},"name":{"description":"Name of the Deal.","type":"string"},"stage_id":{"description":"Stage ID associated with the Deal(You can send either Stage ID or Stage Name.).","type":"integer"},"stage_name":{"description":"Stage name of the Deal(You can send either Stage ID or Stage Name.).","type":"string"},"user_id":{"description":"ID of a User moving the Stage.","type":"integer"},"won_reason":{"items":{"type":"string(Required only if moving to stage CLOSED WON)"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Update the Deal.","tags":["Deal APIs"]}},"/api/external/deals/list":{"get":{"parameters":[{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"User ID listing deals.","example":1,"explode":true,"in":"query","name":"user_id","required":true,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"amount":20000,"amount_currency":"USD","client_company":{"id":1,"img_link":null,"name":"X.Y.Z."},"close_date":"2023-03-09","closed_reasons":{"lost_reason_ids":[16],"lost_reasons":["Lost Reason"],"won_reason_ids":null,"won_reasons":null},"current_stage":{"id":7,"moved_time":"2023-02-28T11:16:46+0000","name":"Closed lost","percentage":0,"rank":7},"custom_fields":[],"deal_owner":{"id":1,"name":"ABC"},"expected_close_date":"2023-03-09","id":2,"name":"test","pipeline":{"id":1,"name":"Default pipeline"}}],"total_deals":1},"schema":{"properties":{"data":{"items":{"properties":{"amount":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"},"pipeline":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"}},"type":"object"},"type":"array"},"total_deals":{"type":"integer"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get List of Deals.","tags":["Deal APIs"]}},"/api/external/document/get":{"get":{"parameters":[{"description":"ID of the document that you want to download","example":10,"explode":true,"in":"query","name":"id","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"summary":"Download a document","tags":["Other APIs"]}},"/api/external/industry/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":1,"name":"Defense & Space"},{"id":2,"name":"Civil Engineering"},{"id":3,"name":"Non-Profit Organization Management"},{"id":4,"name":"Computer Hardware"},{"id":5,"name":"Aviation And Aerospace"}],"total_items":5}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all industries.","tags":["Client APIs"]}},"/api/external/info":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"display_name":"RF (company)"}}}},"description":"Returns display name information"}},"summary":"Get information about the external API.","tags":["Other APIs"]}},"/api/external/job":{"get":{"description":"
    Please find the output format of different engagement types below.

    Engagement Type : Contingent

    Expected Salary


  • expected_salary: {
    currency: \"USD\",
    number: 700000
    }


    • Expected Fee


  • expected_fee : {
    currency: \"USD\",
    number: 35000
    }


    • Job Type


  • job_type : {
    id: 1,
    name: \"Contingent\"
    }


    • Commission Rate


  • commission_rate : 5


    • Engagement Type : Contract

    Job Type


  • job_type : {
    id: 3,
    name: \"Contract\"
    }


    • Contract Start Date


  • contract_start_date : \"2022-08-29\"


    • Contract End Date


  • contract_end_date : \"2022-08-31\"


    • Pay Rate


  • pay_rate : {
    currency: \"USD\",
    number: 5000,
    frequency: {
    display_name: \"hr\",
    id: 1,
    name: \"hour\"
    }
    }


    • Bill Rate


  • bill_rate : {
    currency: \"INR\",
    number: \"5000\",
    frequency: {
    display_name: \"hr\",
    id: 1,
    name: \"hour\"
    }
    }


    • Work Hours


  • work_quantum : {
    frequency : {
    display_name: \"day\",
    id: 1,
    name: \"day\"
    },
    is_full_time : false,
    number : 2,
    unit : {
    display_name: \"hours\",
    id: 1,
    name: \"hour\"
    }
    }


    • Engagement Type : Retained

    Job Type


  • job_type : {
    id: 2,
    name: \"Retained\"
    }


    • Expected Fee


  • expected_fee : {
    currency: \"USD\",
    number: 35000
    }


    • Expected Start Date


  • expected_start_date : \"2022-08-29\"


    • Expected End Date


  • expected_end_date : \"2022-08-31\"


    • Engagement Type : Temporary

    Job Type


  • job_type : {
    id: 4,
    name: \"Temporary\"
    }


    • Pay Rate


  • pay_rate : {
    currency: \"USD\",
    number: 5000,
    frequency: {
    display_name: \"hr\",
    id: 1,
    name: \"hour\"
    }
    }


    • Bill Rate


  • bill_rate : {
    currency: \"INR\",
    number: \"5000\",
    frequency: {
    display_name: \"hr\",
    id: 1,
    name: \"hour\"
    }
    }


    • Work Hours


  • work_quantum : {
    frequency : {
    display_name: \"day\",
    id: 1,
    name: \"day\"
    },
    is_full_time : false,
    number : 2,
    unit : {
    display_name: \"hours\",
    id: 1,
    name: \"hour\"
    }
    }

    • ","parameters":[{"example":10,"explode":true,"in":"query","name":"job_id","required":true,"schema":{"type":"integer"},"style":"form"},{"example":1,"explode":true,"in":"query","name":"include_stages","required":false,"schema":{"type":"integer"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"about_position":"
    Test Job
    ","application_form":[{"parts":[{"key":"personal_info.name","type":"short_text"}],"requirement":"mandatory","text":"Name","type":"short_text"},{"parts":[{"key":"personal_info.email","type":"short_text"}],"requirement":"optional","text":"Email","type":"short_text"},{"parts":[{"key":"personal_info.phone","type":"short_text"}],"requirement":"optional","text":"Phone","type":"short_text"},{"parts":[{"key":"personal_info.location.city","type":"long_text"},{"key":"personal_info.location.state","type":"long_text"},{"key":"personal_info.location.country","type":"long_text"},{"key":"personal_info.location.postal_code","type":"long_text"}],"requirement":"optional","text":"Location","type":"location"}],"apply_link":"https://rfstaging.xyz/recruiterflowstaging/jobs/1","bill_rate":{"currency":"INR","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":"5000"},"company":{"id":1,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/entity-profile-pictures/prod/recruiterflowagency/3/2/q8fhvjf0.jpeg","name":"Guarented I"},"contacts":{"email":"firstcontact@company.com","id":1,"name":"First Contact"},"contract_end_date":"2022-08-31","contract_start_date":"2022-08-29","custom_fields":[{"id":64,"name":"Number field","value":2},{"id":52,"name":"Status","value":"Lead"},{"id":63,"name":"Input field","value":"edfvfd"},{"id":38,"name":"Contract Type","value":"2 week contract"}],"department":"Engineering","employment_type":"Contract","experience_range_end":2,"experience_range_start":1,"files":[{"file_id":48,"filename":"8202:88.docx","link":"https://com-recruiterflow-document-store-eu.s3.amazonaws.com/db_b18c893c749e320e66fbb2f7fef6b1be/documents/48/8202%3A88.docx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJGJEHP5AAWSJVTMA%2F20210119%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210119T084101Z&X-Amz-Expires=604700&X-Amz-SignedHeaders=host&X-Amz-Signature=260d9d5078b196fd494d0442524a34599072fbc3b5b293c99898c5e311a458d3","permission":1,"source":"document store","upload_time":null}],"hiring_team":[{"email":"admin@rfstaging.xyz","first_name":"Chérôme","img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/10447/profile-picture.jpe","last_name":"Shenoy","name":"Chérôme Shenoy","role":"Recruiter","role_id":2,"user_id":10447}],"id":1,"is_open":true,"job_status":{"color":"#FF0000","id":1,"name":"Status 1"},"job_type":{"id":3,"name":"Contract"},"job_visibility_id":1,"job_visibility_info":{"close_reasons":[1,2],"closed_on":"2022-08-31","visibility_id":1},"locations":[{"city":"London","country":"United Kingdom","id":4,"iso_3166_1_alpha_2_code":"GB","name":"London","postal_code":"SE1 9BG","state":null,"zipcode":"SE1 9BG"}],"name":"Staging Job 1","notes":[{"author":{"email":"birendra@recruiterflow.com","first_name":"Birendra","id":1,"img_link":null,"last_name":"Yadav","name":"Birendra Yadav"},"content":"Test note","created_time":"2025-11-05T07:10:00+0000","editable":false,"entities":[{"id":1,"name":"Avenger","type":4}],"id":2,"is_pinned":false,"privacy_level":"everyone","replies":[]}],"number_of_openings":1,"pay_rate":{"currency":"INR","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":"5000"},"publish_to_careers_page":true,"remote_status":{"id":2,"name":"Not Remote"},"salary_range_currency":"USD","salary_range_end":125000,"salary_range_start":100000,"skills":[],"title":"Staging Job 1","work_quantum":{"frequency":{"display_name":"day","id":1,"name":"day"},"is_full_time":false,"number":"2","unit":{"display_name":"hours","id":1,"name":"hour"}}}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"The jobs endpoint allows you to export all jobs-related information from Recruiterflow.","tags":["Job APIs"]}},"/api/external/job-candidate/custom-field/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":101,"name":"Expected salary","type":"money"},{"choices":[{"id":1,"name":"Yes"},{"id":2,"name":"No"}],"id":102,"name":"Willing to relocate?","type":"single_select"}],"total_items":2}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all job-candidate custom fields.","tags":["Candidate APIs"]}},"/api/external/job-candidate/custom-field/value/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"candidate_id","required":true,"schema":{"type":"integer"}},{"in":"query","name":"job_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":102,"name":"Willing to relocate?","value":"Yes"},{"id":101,"name":"Expected salary","value":{"currency":"USD","number":120000}}]}}}},"description":"List of custom field values"}},"summary":"Returns current values for job-candidate custom fields.","tags":["Candidate APIs"]}},"/api/external/job-candidate/custom-field/value/update":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"candidate_id":30,"custom_fields":[{"id":82,"value":["Seattle","San Jose"]},{"id":81,"value":5},{"id":80,"value":"This is from API"}],"job_id":1},"schema":{"properties":{"candidate_id":{"type":"integer"},"custom_fields":{"items":{"properties":{"id":{"type":"integer"},"value":{"description":"Value format depends on field type"}},"type":"object"},"type":"array"},"job_id":{"type":"integer"}},"required":["candidate_id","job_id","custom_fields"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"RESULT":"SUCCESS"}}}},"description":"SUCCESS"}},"summary":"Updates job-candidate custom field values.","tags":["Candidate APIs"]}},"/api/external/job-remote-status/list":{"get":{"parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":3,"name":"Hybrid"},{"id":2,"name":"Not Remote"},{"id":1,"name":"Remote"}]}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all job remote status.","tags":["Job APIs"]}},"/api/external/job-status/list":{"get":{"parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"color":"#dd00aa","id":1,"name":"Status 1"},{"color":"#ff1133","id":2,"name":"Status 2"}],"total_items":2}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all job status.","tags":["Job APIs"]}},"/api/external/job-template/list":{"get":{"parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":1,"name":"Contract Job Template"},{"id":2,"name":"Permanent Job Template"}]}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all job templates.","tags":["Job APIs"]}},"/api/external/job/activity-type/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"category":"Communication","id":1,"is_archived":false,"is_custom":false,"name":"Note","rank":1},{"category":"Communication","id":2,"is_archived":false,"is_custom":false,"name":"Email","rank":2},{"category":"Job-related","id":3,"is_archived":false,"is_custom":false,"name":"Scorecard","rank":3},{"category":"Custom","id":1001,"is_archived":false,"is_custom":true,"name":"Lunch with candidate","rank":1001}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all activity types for job.","tags":["Job APIs"]}},"/api/external/job/activity/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Job ID for which the activities are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"activity_id":3376,"associated_entities":{"candidates":[],"clients":[],"contacts":[],"deals":[],"jobs":[{"id":1,"name":"Test job"}]},"candidate_id":null,"contact_id":null,"interview_plan_id":null,"is_custom":false,"job_id":1,"subject":"Michael Scott updated this job","text":"","time":"2023-11-22T16:14:41+00:00","type":{"id":22,"name":"Job updated"},"user":{"email":"testemail@testdomain.com","first_name":"Michael","id":1,"last_name":"Scott","name":"Michael Scott"}}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get paginated list of activities for a job.","tags":["Job APIs"]}},"/api/external/job/calls/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Job ID for which the calls are needed.","example":22,"explode":false,"in":"query","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"After time for which the calls are needed in ISO format.","example":"2023-04-30T10:30:00","explode":false,"in":"query","name":"after","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Before time for which the calls are needed in ISO format.","example":"2023-05-01T15:00:00","explode":false,"in":"query","name":"before","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"end_time":"2023-05-01T03:36:00+0000","entities":[{"id":22,"name":"Avengers","type":"Job"}],"id":1,"meeting_type":"Meeting Type","notes":{"notes":"
    HI test call
    ","users":[]},"outcome":"Busy","start_time":"2023-05-01T02:36:00+0000","title":"Call Title","user":{"id":1,"name":"Tony Stark"}}],"total_items":1}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Get all calls list for a job","tags":["Job APIs"]}},"/api/external/job/close":{"post":{"parameters":[{"example":"e0fb97af10fe90c9e4ead24924121328b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"close_reasons":{"items":{"type":"string"},"type":"array"},"job_id":{"description":"ID of the job in Recruiterflow.","type":"integer"},"user_id":{"description":"ID of the user in Recruiterflow","type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"RESULT":"SUCCESS"}}}},"description":"API returns a 200 OK response if the job is successfully closed"}},"summary":"Close a job in Recruiterflow","tags":["Job APIs"]}},"/api/external/job/count":{"get":{"parameters":[{"description":"1 -> True, 0-> False","explode":true,"in":"query","name":"only_open","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"department ids.","explode":true,"in":"query","name":"departments","required":false,"schema":{"type":"string"},"style":"form"},{"description":"location ids.","explode":true,"in":"query","name":"locations","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"count":70}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"All filters available in the /api/external/job/list API except current_page, items_per_page","tags":["Job APIs"]}},"/api/external/job/create":{"post":{"description":"
    Please find the input format details below.
  • about_position:
    Job Description


  • client_company_id:
    Please refer to the list of clients in client list api in the doc.


  • created_by:
    Id of the user creating the job.


  • department_id:
    Find the list of department ids in Other APIS.


  • employment_type_id:
    Find the list of employment type ids in Other APIS.


  • locations:
    Array of location ids, get the list of locations from /api/external/location/list API.


  • title:
    Job title.


    • Please find the format of custom field input below.
  • Single select:
    {
    \"id\": single_select_cf_id,
    \"value\": choice id (get the list from candidate/custom-field/list)
    }


  • Multi select :
    {
    \"id\": multi_select_cf_id,
    \"value\": [choice id1, choice id2] (get the list from candidate/custom-field/list)
    }


  • Short/Long text:
    {
    \"id\": short_text_cf_id,
    \"value\": \"text\"
    }


  • Money:
    {
    \"id\": money custom field id,
    \"value\": {\"number\": Integer(The amount), \"currency\": \"string(Currency code eg. USD, GBP)\"}
    }

  • Money Range:
    {
    \"id\": money reange custom field id,
    \"value\": {\"number1\": Integer(Starting Amount), \"number2\": \"Ending Amount\", \"currency\": \"string(Currency code eg. USD, GBP)\"}
    }

  • Number/Date:
    {
    \"id\": cf_id,
    \"value\": number/date to store
    }


  • Yes No:
    {
    \"id\": yes_no_cf_id,
    \"value\": 0 for No and 1 for Yes
    }


  • Parent-Child :
    {
    \"id\": parent-child-cf-id,
    \"value\": [{\"name\": \"parent_name\", \"children\": [\"child1\", \"child2\"]}]
    }


  • Profile:
    {
    \"id\": profile_cf_id,
    \"value\": [{\"type\": \"candidate\", \"id\": candidate_id}]
    }


  • Users:
    {
    \"id\": users_cf_id,
    \"value\": [integer_user_id_1, integer_user_id_1]
    }


    • ","parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"about_position\": \"Job Description\",\n \"client_company_id\": 385,\n \"created_by\": 1,\n \"department_id\": 1,\n \"employment_type_id\": 1,\n \"locations\": [55],\n \"skills\": [\"python\", \"java\"],\n \"contacts\": [1, 2],\n \"title\": \"External Job\",\n \"experience_range_start\": 1,\n \"experience_range_end\": 3,\n \"salary_range_start\": 10000,\n \"salary_range_end\": 200000,\n \"hiring_team\": [\n {\n \"id\": 5,\n \"values\": [\n {\n \"user_id\": 3\n }\n ]\n },\n {\n \"id\": 2,\n \"values\": [\n {\n \"user_id\": 1\n }\n ]\n }\n ],\n \"custom_fields\": [\n {\n \"id\": 11,\n \"value\": {\"currency\": \"USD\", \"number\": 600000}\n },\n {\n \"id\": 9,\n \"value\": {\"currency\": \"USD\", \"number1\": 600000, \"number2\": 800000}\n },\n {\n \"id\": 10,\n \"value\": {\"number1\": 600000, \"number2\": 800000}\n },\n {\n \"id\": 12,\n \"value\": \"2021-10-31\"\n },\n {\n \"id\" : 5,\n \"value\" : \"Random long\"\n },\n {\n \"id\" : 4,\n \"value\" : \"Random short\"\n }\n ]\n}"}},"schema":{"properties":{"about_position":{"type":"string"},"added_time":{"type":"string"},"client_company_id":{"description":"Please refer to the list of clients in client list api in the doc.","type":"integer"},"contacts":{"description":"Find the list of contact ids in contact list API.","items":{"type":"integer"},"type":"array"},"created_by":{"description":"Id of the user creating the job.","type":"integer"},"custom_fields":{"description":"Please refer to doc above","items":{"properties":{"id":{"type":"integer"},"value":{"type":"string"}},"type":"object"},"type":"array"},"department_id":{"description":"Find the list of department ids in Other APIS.","type":"integer"},"employment_type_id":{"description":"Find the list of employment type ids in Other APIS.","type":"integer"},"experience_range_end":{"type":"integer"},"experience_range_start":{"type":"integer"},"hiring_team":{"items":{"properties":{"id":{"type":"integer"},"values":{"items":{"properties":{"user_id":{"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"locations":{"items":{"type":"integer"},"type":"array"},"number_of_openings":{"type":"integer"},"salary_range_end":{"type":"number"},"salary_range_start":{"type":"number"},"skills":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Auto generated using Swagger Inspector"}},"summary":"Create a new job.","tags":["Job APIs"]}},"/api/external/job/custom-field/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":65,"name":"JobCFDate","type":"date"},{"id":64,"name":"Number field","type":"number"},{"choices":[{"id":683,"name":"Active"},{"id":684,"name":"Lead"},{"id":720,"name":"New Status Stuff"},{"id":748,"name":"choice 1"}],"id":52,"name":"Status","type":"single_select"},{"id":63,"name":"Input field","type":"long_text"},{"id":50,"name":"Active","type":"yes_no"}],"total_items":7}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all job custom fields available.","tags":["Job APIs"]}},"/api/external/job/department/list":{"get":{"parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"count":126,"id":1,"name":"Engineering"},{"count":10,"id":2,"name":"Marketing"},{"count":0,"id":8,"name":"testDepartment"},{"count":8,"id":12,"name":"Data Engineer"}],"total_items":4}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all job departments.","tags":["Job APIs"]}},"/api/external/job/engagement-type/list":{"get":{"parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":1,"name":"Contingent"},{"id":3,"name":"Contract"},{"id":2,"name":"Retained"},{"id":4,"name":"Temporary"}],"total_items":4}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all job engagement type.","tags":["Job APIs"]}},"/api/external/job/file/add":{"post":{"description":"If file is being added by url, file_name is mandatory
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file_name":{"type":"string"},"files":{"format":"binary","type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS","data":{"num_files":3}},"schema":{"properties":{"RESULT":{"type":"string"},"data":{"properties":{"num_files":{"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Please add ARGUMENTS (AS A FORM), the api is used to attach files to jobs.","tags":["Job APIs"]}},"/api/external/job/list":{"get":{"description":"Please find the output format of different engagement types below.

    Engagement Type : Contingent

    Expected Salary


  • expected_salary: {
    currency: \"USD\",
    number: 700000
    }


    • Expected Fee


  • expected_fee : {
    currency: \"USD\",
    number: 35000
    }


    • Job Type


  • job_type : {
    id: 1,
    name: \"Contingent\"
    }


    • Commission Rate


  • commission_rate : 5


    • Engagement Type : Contract

    Job Type


  • job_type : {
    id: 3,
    name: \"Contract\"
    }


    • Contract Start Date


  • contract_start_date : \"2022-08-29\"


    • Contract End Date


  • contract_end_date : \"2022-08-31\"


    • Pay Rate


  • pay_rate : {
    currency: \"USD\",
    number: 5000,
    frequency: {
    display_name: \"hr\",
    id: 1,
    name: \"hour\"
    }
    }


    • Bill Rate


  • bill_rate : {
    currency: \"INR\",
    number: \"5000\",
    frequency: {
    display_name: \"hr\",
    id: 1,
    name: \"hour\"
    }
    }


    • Work Hours


  • work_quantum : {
    frequency : {
    display_name: \"day\",
    id: 1,
    name: \"day\"
    },
    is_full_time : false,
    number : 2,
    unit : {
    display_name: \"hours\",
    id: 1,
    name: \"hour\"
    }
    }


    • Engagement Type : Retained

    Job Type


  • job_type : {
    id: 2,
    name: \"Retained\"
    }


    • Expected Fee


  • expected_fee : {
    currency: \"USD\",
    number: 35000
    }


    • Expected Start Date


  • expected_start_date : \"2022-08-29\"


    • Expected End Date


  • expected_end_date : \"2022-08-31\"


    • Engagement Type : Temporary

    Job Type


  • job_type : {
    id: 4,
    name: \"Temporary\"
    }


    • Pay Rate


  • pay_rate : {
    currency: \"USD\",
    number: 5000,
    frequency: {
    display_name: \"hr\",
    id: 1,
    name: \"hour\"
    }
    }


    • Bill Rate


  • bill_rate : {
    currency: \"INR\",
    number: \"5000\",
    frequency: {
    display_name: \"hr\",
    id: 1,
    name: \"hour\"
    }
    }


    • Work Hours


  • work_quantum : {
    frequency : {
    display_name: \"day\",
    id: 1,
    name: \"day\"
    },
    is_full_time : false,
    number : 2,
    unit : {
    display_name: \"hours\",
    id: 1,
    name: \"hour\"
    }
    }


    • Notes


  • \"notes\": [
    {
    \"author\": {
    \"email\": \"test@xyz.com\",
    \"first_name\": \"Test\",
    \"id\": 1,
    \"img_link\": null,
    \"last_name\": \"user\",
    \"name\": \"Test user\"
    },
    \"content\": 'Test note',
    \"created_time\": \"2025-11-05T07:10:00+0000\",
    \"editable\": false,
    \"entities\": [
    {
    \"id\": 1,
    \"name\": \"Test job\",
    \"type\": 4
    }
    ],
    \"id\": 2,
    \"is_pinned\": false,
    \"privacy_level\": \"everyone\",
    \"replies\": []
    }
    ]


    • Note: Structure changes to {\"data\": [], \"total_items\": int, \"total_current_openings\": int} when include_count is enabled.


    ","parameters":[{"example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Job Notes","example":true,"explode":true,"in":"query","name":"include_notes","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Job Description","example":true,"explode":true,"in":"query","name":"include_description","required":false,"schema":{"type":"string"},"style":"form"},{"description":"1 -> True, 0-> False","explode":true,"in":"query","name":"only_open","required":false,"schema":{"type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":[{"about_position":"This is a test job","apply_link":"https://rfstaging.xyz/recruiterflowstaging/jobs/1","bill_rate":{"currency":"INR","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":"5000"},"commission_rate":5,"contract_end_date":"2022-08-31","contract_start_date":"2022-08-29","current_opening":1,"custom_fields":[{"id":64,"name":"Number field","value":2},{"id":52,"name":"Status","value":"Lead"},{"id":63,"name":"Input field","value":"edfvfd"},{"id":38,"name":"Contract Type","value":"2 week contract"}],"department":"Engineering","employment_type":"Contract","experience_range_end":2,"experience_range_start":1,"hiring_team":[{"email":"admin@rfstaging.xyz","first_name":"Chérôme","img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/10447/profile-picture.jpe","last_name":"Shenoy","name":"Chérôme Shenoy","role":"Recruiter","role_id":2,"user_id":10447}],"id":1,"is_open":true,"job_status":{"color":"#FF0000","id":1,"name":"Status 1"},"job_type":{"id":3,"name":"Contract"},"job_visibility_id":1,"last_opened":"2025-05-26T13:13:33+05:30","locations":[{"city":"London","country":"United Kingdom","id":4,"iso_3166_1_alpha_2_code":"GB","name":"London","postal_code":"SE1 9BG","state":null,"zipcode":"SE1 9BG"}],"maildrop_email":"maildrop+recruiterflowcompany_3170f227@recruiterflow.com","name":"Staging Job 1","number_of_openings":1,"pay_rate":{"currency":"INR","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":"5000"},"publish_to_careers_page":true,"salary_frequency":"month","salary_range_currency":"USD","salary_range_end":5000,"salary_range_start":1000,"title":"Staging Job 1","work_quantum":{"frequency":{"display_name":"day","id":1,"name":"day"},"is_full_time":false,"number":"2","unit":{"display_name":"hours","id":1,"name":"hour"}}}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all jobs in the account.","tags":["Job APIs"]}},"/api/external/job/notes/add":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"created_by":{"type":"integer"},"id":{"description":"id of the Job.","type":"integer"},"mentions":{"items":{"type":"integer"},"type":"array"},"value":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"note_id":1}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Adds note to the specified job record.","tags":["Job APIs"]}},"/api/external/job/open":{"post":{"parameters":[{"example":"e0fb97af10fe90c9e4ead24924121328b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"job_id":{"description":"ID of the job in Recruiterflow.","type":"integer"},"user_id":{"description":"ID of the user in Recruiterflow","type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"RESULT":"SUCCESS"}}}},"description":"API returns a 200 OK response if the job is successfully closed"}},"summary":"Open a job in Recruiterflow","tags":["Job APIs"]}},"/api/external/job/pipeline":{"get":{"parameters":[{"example":10,"explode":true,"in":"query","name":"job_id","required":false,"schema":{"type":"integer"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"detail":[],"summary":[{"count":0,"id":1,"name":"Sourced"},{"count":0,"id":2,"name":"Applied"},{"count":0,"id":3,"name":"Company Submission"},{"count":0,"id":4,"name":"On-site Interview"},{"count":0,"id":5,"name":"Disqualified"},{"count":0,"id":6,"name":"Offer"},{"count":0,"id":7,"name":"Hired"}]}}}},"description":"Returns detailed information about a job's pipeline"}},"summary":"Returns detailed information about a job's pipeline","tags":["Job APIs"]}},"/api/external/job/placement-record/list":{"get":{"parameters":[{"example":10,"explode":true,"in":"query","name":"job_id","required":true,"schema":{"type":"string"},"style":"form"},{"example":1,"explode":true,"in":"query","name":"detailed","required":false,"schema":{"type":"string"},"style":"form"},{"example":1,"explode":true,"in":"query","name":"user_id","required":false,"schema":{"type":"string"},"style":"form"},{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"bill_rate":{"currency":"USD","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":56546},"billing_date":null,"bonus":{"currency":"USD","number":null},"contacts":[{"email":null,"id":32,"img_link":null,"label":"jhcbvjh","name":"jhcbvjh","type":2,"value":32}],"contract_end_date":null,"contract_start_date":null,"id":418,"job":{"client_company":{"id":30860,"name":"Test company Varun"},"id":17114,"job_type":{"id":4,"name":"Temporary"},"job_visibility_id":6,"name":"ts test job"},"job_start_date":"2023-02-13","note":"","pay_rate":{"currency":"USD","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":56546},"prospect":{"id":30,"name":"yghj"},"retainer":{"currency":"USD","frequency":{"display_name":"net","id":1,"name":"net"},"number":4677576},"revenue":{"currency":"USD","number":0},"revenue_split":[{"revenue":{"number":0,"pct":12},"user":{"id":1}}],"salary":{"currency":"USD","number":null},"success_fee":{"currency":"USD","number":null},"user":{"id":102035},"version":{"id":420},"work_quantum":{"frequency":{"display_name":"week","id":2,"name":"week"},"is_full_time":false,"number":1,"unit":{"display_name":"days","id":2,"name":"day"}}}],"total_items":1}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all placements for specified job.","tags":["Placement APIs"]}},"/api/external/job/salary-frequency/list":{"get":{"parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":1,"name":"hour"},{"id":2,"name":"day"},{"id":3,"name":"week"},{"id":4,"name":"month"},{"id":5,"name":"year"}]}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all job supported salary frequencies","tags":["Job APIs"]}},"/api/external/job/search":{"post":{"description":"
    Link

    Note: Structure changes to {\"data\": [], \"total_items\": int} when include_count is enabled.


    Please find the format of custom field input below.
    {
    \"conjunction\": \"match-all\",
    \"current_page\": 1,
    \"filters\": [
    # Please add here from below list, according to your requirements!
    ],
    \"items_per_page\": 100
    }

  • Job company:
    {
    \"conjunction\": \"in\",
    \"key\": \"job_client_company\",
    \"values\": [4]
    }


  • Job Department:
    {
    \"conjunction\": \"in\",
    \"key\": \"job_department\",
    \"values\": [1]
    }


  • Job ID:
    {
    \"conjunction\": \"in\",
    \"key\": \"job_id\",
    \"values\": [1,2]
    }


  • Job Name:
    {
    \"conjunction\": \"in\",
    \"key\": \"name\",
    \"values\": [\"Creator\"]
    }


  • Job Custom field long and short text:
    {
    \"conjunction\": \"in\",
    \"key\": \"custom_field.5\",
    \"values\": [\"sample_long_text\"]
    }


  • Job Custom field Multiselect/Single-select/Yes_No:
    {
    \"conjunction\": \"in\",
    \"key\": \"custom_field.6\",
    \"values\": [4],
    }


  • Job Custom field Date:
    { \"conjunction\": \"in\",
    \"key\": \"custom_field.12\",
    \"date\": \"2021-10-04\",
    \"is_relative\": false,
    \"filter_type\": \"after\"
    }


  • Job Custom field Number <\"filter_type\": \"more-than/less-than/equal-to/between\">:
    {
    \"conjunction\": \"in\",
    \"key\": \"custom_field.2\",
    \"filter_type\": \"more-than\",
    \"value\": \"10\"
    }


  • Job Custom field Number <\"filter_type\": \"between\">:
    {
    \"conjunction\": \"in\",
    \"key\": \"custom_field.2\",
    \"filter_type\": \"between\",
    \"min_value\": \"22\",
    \"max_value\": \"33\"
    }


  • Job Custom field Money <\"filter_type\": \"more-than/less-than/equal-to/between\">:
    {
    \"conjunction\": \"in\",
    \"key\": \"custom_field.11\",
    \"filter_type\": \"more-than\",
    \"value\": {
    \"currency\": \"INR\",
    \"number\": \"22\"
    }
    }


  • Job Custom field Money <\"filter_type\": \"between\">:
    {
    \"conjunction\": \"in\",
    \"key\": \"custom_field.11\",
    \"filter_type\": \"between\",
    \"min_value\": \"22\",
    \"max_value\": \"33\"
    }


  • Job Custom field Money range <\"type\": \"range\">:
    {
    \"conjunction\": \"in\",
    \"input\": \"money\",
    \"key\": \"custom_field.11\",
    \"value\": {
    \"currency\": \"INR\",
    \"number\": \"22\"
    }
    }


    • ","parameters":[{"example":"83f5e5e4a6429af12b420d7f3908d3c6","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":{"conjunction":"match-all","current_page":1,"filters":[{"conjunction":"in","key":"job_client_company","values":[4]},{"conjunction":"in","key":"job_department","values":[1]},{"conjunction":"in","key":"name","values":["Creator"]},{"conjunction":"in","key":"custom_field.4","values":["sample_short_text"]},{"conjunction":"in","key":"custom_field.5","values":["sample_long_text"]},{"conjunction":"in","date":"2021-10-04","filter_type":"after","is_relative":false,"key":"custom_field.12"}],"include_count":false,"include_description":true,"items_per_page":100}}},"schema":{"properties":{"conjunction":{"type":"string"},"current_page":{"type":"integer"},"filters":{"items":{"properties":{"conjunction":{"type":"string"},"date":{"type":"string"},"filter_type":{"type":"string"},"is_relative":{"type":"boolean"},"key":{"type":"string"}},"type":"object"},"type":"array"},"include_count":{"type":"boolean"},"include_description":{"type":"boolean"},"items_per_page":{"type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":[[{"about_position":"This is job decsription","apply_link":"http://localhost:5000/recruiterflow/jobs/20","client_company_id":15,"client_company_name":"Mindtree","contact":[],"created_by":{"email":"anuj@recruiterflow.com","id":3,"name":"Anuj Singh"},"custom_fields":[],"cvlibrary_enabled":false,"department":"Marketing","department_id":3,"dice_enabled":false,"employment_type":"Full time","employment_type_id":1,"force_job_posting":false,"glassdoor_enabled":false,"hiring_team":[],"id":20,"iimjobs_enabled":false,"indeed_enabled":false,"itjobs_enabled":false,"job_id":20,"job_visibility_id":1,"jobsite_enabled":false,"jooble_enabled":false,"last_opened":"2021-02-16T05:58:52+0000","linkedin_enabled":false,"locations":[{"city":null,"country":null,"id":7,"iso_3166_1_alpha_2_code":null,"name":"Chennai","postal_code":"","state":"","zipcode":""}],"maildrop_suffix":"recruiterflow_d91fbaec","my_job":false,"name":"Marketing Executive","salary_range_currency":"USD","salary_range_end":null,"salary_range_start":null,"simplyhired_enabled":false,"telcoprofessionals_enabled":false,"title":"Marketing Executive","ziprecruiter_enabled":false,"zoek_enabled":false}],{"applied":{"1":0,"14":0,"15":0,"16":0,"17":2,"2":0,"20":0,"4":0,"5":0,"6":1},"disqualified":{"20":0},"hired":{"20":0},"last_week":{"20":0},"sourced":{"1":15,"14":1,"15":1,"16":1,"17":0,"2":2,"20":0,"4":1,"5":2,"6":1},"submissions":{"20":0},"total":{"1":15,"14":1,"15":1,"16":1,"17":2,"2":2,"20":0,"4":1,"5":2,"6":2}}]}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Searches job with a specific filter or query","tags":["Job APIs"]}},"/api/external/job/stage_names":{"get":{"parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":["Applied","Company Submission","Disqualified","Hired","Offer","On-site Interview","Sourced","Phone Interview","First Interview","Onsite Interview"]}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all job distinct stage names in the account.","tags":["Job APIs"]}},"/api/external/job/update":{"post":{"parameters":[{"example":"83f5e5e4a6429af12b420d7f3908d3c6","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"about_position":{"type":"string"},"close_reasons":{"items":{"type":"string"},"type":"array"},"contacts":{"description":"Find the list of contact ids in contact list API.","items":{"type":"integer"},"type":"array"},"custom_fields":{"items":{"properties":{"id":{"type":"integer"},"value":{"type":"object"}},"type":"object"},"type":"array"},"department_id":{"type":"integer"},"employment_type_id":{"type":"integer"},"experience_range_end":{"type":"integer"},"experience_range_start":{"type":"integer"},"hiring_team":{"items":{"properties":{"id":{"type":"integer"},"values":{"items":{"properties":{"user_id":{"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"job_id":{"type":"integer"},"job_remote_status":{"type":"integer"},"job_status_id":{"type":"integer"},"job_visibility_id":{"type":"integer"},"locations":{"items":"type:integer","type":"array"},"name":{"type":"string"},"number_of_openings":{"type":"integer"},"salary_range_end":{"type":"number"},"salary_range_start":{"type":"number"},"skills":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"RESULT":"SUCCESS"}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"External API for Job Update","tags":["Job APIs"]}},"/api/external/job/visibility/list":{"get":{"parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":1,"name":"External"},{"id":3,"name":"Internal"},{"id":2,"name":"Unlisted"},{"id":4,"name":"Confidential"}]}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all job visibilities","tags":["Job APIs"]}},"/api/external/location/create":{"post":{"description":"The endpoint returns the id of the location created.
    ","parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"city":{"description":"Name of the city.","type":"string"},"country":{"type":"string"},"details":{"type":"string"},"location_state":{"type":"string"},"location_zipcode":{"type":"string"},"name":{"description":"Location name.","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"RESULT":"SUCCESS","id":1}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Create a job location that is not present in the system, use location list api to see all available locations.","tags":["Job APIs"]}},"/api/external/location/delete":{"post":{"parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"Location id.","type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"RESULT":"SUCCESS"}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Deletes the specified job location from the system","tags":["Job APIs"]}},"/api/external/location/list":{"get":{"parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"},{"description":"to fetch locations of open jobs only","example":true,"explode":true,"in":"query","name":"open_jobs_only","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"city":null,"country":null,"details":null,"id":55,"iso_3166_1_alpha_2_code":null,"location_type":"Physical","location_type_id":1,"name":"Test loc 3","postal_code":"575 009","state":"Karnataka","zipcode":"575 009"},{"city":"Bangalore","country":"India","details":null,"id":56,"iso_3166_1_alpha_2_code":"IN","location_type":"Physical","location_type_id":1,"name":"Test loc 4","postal_code":"575 000","state":"Karnataka","zipcode":"575 000"},{"city":null,"country":null,"details":null,"id":30,"iso_3166_1_alpha_2_code":null,"location_type":"Physical","location_type_id":1,"name":"x","postal_code":"","state":"y","zipcode":""},{"city":null,"country":null,"details":null,"id":32,"iso_3166_1_alpha_2_code":null,"location_type":"Physical","location_type_id":1,"name":"y","postal_code":"98768","state":"Bangladesh","zipcode":"98768"}],"total_items":4}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all job locations in the account.","tags":["Job APIs"]}},"/api/external/location/update":{"post":{"parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"city":{"description":"Name of the city.","type":"string"},"country":{"type":"string"},"details":{"type":"string"},"id":{"type":"integer"},"location_state":{"type":"string"},"location_zipcode":{"type":"string"},"name":{"description":"Location name.","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"RESULT":"SUCCESS"}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Updates job location details(name, state, city, country, zip code)","tags":["Job APIs"]}},"/api/external/notes/delete":{"post":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"deleted_by":{"description":"User id.","type":"integer"},"id":{"description":"Note id.","type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"RESULT":"SUCCESS"}}},"description":"Auto generated using Swagger Inspector"}},"summary":"End point to delete any notes","tags":["Other APIs"]}},"/api/external/organization/employment-type/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":4,"name":"Contract"},{"id":1,"name":"Full time"},{"id":5,"name":"Internship"},{"id":2,"name":"Part time"},{"id":3,"name":"Temporary"}],"total_items":5}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"List of employment types.","tags":["Other APIs"]}},"/api/external/organization/location/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"city":"Bangalore","country":"India","id":43,"iso_3166_1_alpha_2_code":"IN","name":"Test loc 1","state":"Karnataka","zipcode":"575 009"},{"city":"Bangalore","country":"India","id":44,"iso_3166_1_alpha_2_code":"IN","name":"Test loc 2","state":"Karnataka","zipcode":"575 009"},{"city":null,"country":null,"id":55,"iso_3166_1_alpha_2_code":null,"name":"Test loc 3","state":"Karnataka","zipcode":"575 009"},{"city":"Bangalore","country":"India","id":56,"iso_3166_1_alpha_2_code":"IN","name":"Test loc 4","state":"Karnataka","zipcode":"575 000"},{"city":null,"country":null,"id":30,"iso_3166_1_alpha_2_code":null,"name":"x","state":"y","zipcode":""},{"city":null,"country":null,"id":32,"iso_3166_1_alpha_2_code":null,"name":"y","state":"Bangladesh","zipcode":"98768"}],"total_items":6}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"List of organization locations.","tags":["Other APIs"]}},"/api/external/placement-record/create":{"post":{"description":"\n**The below table describes the required input without any job engagement type**\n\n|

    Params

    |

    Data Type

    |

    Required

    |\n| ------------------ | ------------------ | ----------------- |\n| job | object | True |\n| prospect | object | True |\n| revenue | object | optional |\n| salary | object | optional |\n| revenue_split | object | optional |\n| contacts | array | optional |\n| billing_date | date | True |\n| bonus | object | optional |\n| job_start_date | date | optional |\n| note | string | optional |\n| user_id | integer | True |\n| custom_fields | array | optional |\n\n**Sample Payload**\n```\n{\n \"user_id\": 1 (Integer),\n \"placements\": [\n {\n \"job\": {\n \"id\": 6 (Integer)\n },\n \"prospect\": {\n \"id\": 30 (Integer)\n },\n \"revenue\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"salary\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1 (Integer)\n },\n \"revenue\": {\n \"number\": 0, (Integer)\n \"pct\": 12 (Integer)\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32 (Integer)\n }\n ],\n \"billing_date\": \"2023-03-8\" (String),\n \"bonus\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"job_start_date\": \"2023-02-14\", (String)\n \"note\": \"\", (String)\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\" (String, Currency code eg. USD, GBP), \"number\": 600000 (float)}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\" (String), \"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"] (list of strings)\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\" (String)\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}\n```\n\n**The below table describes the required input based on job engagement type**\n\n**1 : Job Type Contingent**\n\n|

    Params

    |

    Data Type

    |

    Required

    |\n| ------------------ | ------------------ | ----------------- |\n| job | object | True |\n| prospect | object | True |\n| revenue | object | optional |\n| salary | object | optional |\n| revenue_split | object | optional |\n| contacts | array | optional |\n| billing_date | date | True |\n| bonus | object | optional |\n| job_start_date | date | optional |\n| note | string | optional |\n| user_id | integer | True |\n| custom_fields | array | optional |\n\n**Sample Payload**\n```\n{\n \"user_id\": 1 (Integer),\n \"placements\": [\n {\n \"job\": {\n \"id\": 6 (Integer)\n },\n \"prospect\": {\n \"id\": 30 (Integer)\n },\n \"revenue\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"salary\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1 (Integer)\n },\n \"revenue\": {\n \"number\": 0, (Integer)\n \"pct\": 12 (Integer)\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32 (Integer)\n }\n ],\n \"billing_date\": \"2023-03-8\" (String),\n \"bonus\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"job_start_date\": \"2023-02-14\", (String)\n \"note\": \"\", (String)\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\" (String, Currency code eg. USD, GBP), \"number\": 600000 (float)}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\" (String), \"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"] (list of strings)\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\" (String)\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}\n```\n\n**2 : Job Type Contract**\n\n|

    Params

    |

    Data Type

    |

    Required

    |\n| ------------------ | ------------------ | ----------------- |\n| job | object | True |\n| prospect | object | True |\n| revenue_split | object | optional |\n| contacts | array | optional |\n| contract_start_date| date | optional |\n| contract_end_date | date | optional |\n| pay_rate | date | optional |\n| bill_rate | date | optional |\n| work_quantum | date | optional |\n| bonus | object | optional |\n| note | string | optional |\n| user_id | integer | True |\n| custom_fields | array | optional |\n\n**Sample Payload**
    \n* __Allowed bill rate frequency__\n 1. hour\n 2. day\n 3. week\n 4. month\n* __Allowed pay rate frequency__\n 1. hour\n 2. day\n 3. week\n 4. month\n* __Allowed work quantum frequency__\n 1. day\n 2. week\n 3. month\n* __Allowed work quantum unit__\n 1. hour\n 2. day\n 3. week\n```\n{\n \"user_id\": 1 (Integer),\n \"placements\": [\n {\n \"job\": {\n \"id\": 6 (Integer)\n },\n \"prospect\": {\n \"id\": 30 (Integer)\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1 (Integer)\n },\n \"revenue\": {\n \"number\": 0, (Integer)\n \"pct\": 12 (Integer)\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32 (Integer)\n }\n ],\n \"contract_start_date\": \"2023-03-8\" (String),\n \"contract_end_date\": \"2023-03-8\" (String),\n \"pay_rate\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n \"frequency\": {\n \"name\": \"hour\" (String)\n }\n },\n \"bill_rate\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n \"frequency\": {\n \"name\": \"hour\" (String)\n }\n },\n \"work_quantum\": {\n \"number\": 1 (Integer)\n \"unit\": {\n \"name\": \"hour\" (String)\n },\n \"frequency\": {\n \"name\": \"day\" (String)\n },\n \"is_full_time\": false (Boolean)\n },\n \"bonus\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"note\": \"\", (String)\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\" (String, Currency code eg. USD, GBP), \"number\": 600000 (float)}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\" (String), \"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"] (list of strings)\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\" (String)\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}\n```\n\n**3 : Job Type Retained**\n\n|

    Params

    |

    Data Type

    |

    Required

    |\n| ------------------ | ------------------ | ----------------- |\n| job | object | True |\n| prospect | object | True |\n| salary | object | optional |\n| revenue_split | object | optional |\n| contacts | array | optional |\n| billing_date | date | True |\n| bonus | object | optional |\n| job_start_date | date | optional |\n| success_fee | object | optional |\n| retainer | object | optional |\n| note | string | optional |\n| user_id | integer | True |\n| custom_fields | array | optional |\n\n**Sample Payload**
    \n* __Allowed retainer frequency__\n 1. net\n 2. hour\n 3. day\n 4. month\n\n```\n{\n \"user_id\": 1 (Integer),\n \"placements\": [\n {\n \"job\": {\n \"id\": 6 (Integer)\n },\n \"prospect\": {\n \"id\": 30 (Integer)\n },\n \"salary\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1 (Integer)\n },\n \"revenue\": {\n \"number\": 0, (Integer)\n \"pct\": 12 (Integer)\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32 (Integer)\n }\n ],\n \"billing_date\": \"2023-03-8\" (String),\n \"bonus\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"job_start_date\": \"2023-02-14\", (String)\n \"success_fee\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"retainer\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n \"frequency\": {\n \"name\": \"net\" (String)\n }\n },\n \"note\": \"\", (String)\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\" (String, Currency code eg. USD, GBP), \"number\": 600000 (float)}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\" (String), \"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"] (list of strings)\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\" (String)\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}\n```\n\n**4 : Job Type Temporary**\n\n|

    Params

    |

    Data Type

    |

    Required

    |\n| ------------------ | ------------------ | ----------------- |\n| job | object | True |\n| prospect | object | True |\n| revenue_split | object | optional |\n| contacts | array | optional |\n| pay_rate | date | optional |\n| bill_rate | date | optional |\n| work_quantum | date | optional |\n| job_start_date | date | optional |\n| note | string | optional |\n| user_id | integer | True |\n| custom_fields | array | optional |\n\n**Sample Payload**\n* __Allowed bill rate frequency__\n 1. hour\n 2. day\n 3. week\n 4. month\n* __Allowed pay rate frequency__\n 1. hour\n 2. day\n 3. week\n 4. month\n* __Allowed work quantum frequency__\n 1. day\n 2. week\n 3. month\n* __Allowed work quantum unit__\n 1. hour\n 2. day\n 3. week\n```\n{\n \"user_id\": 1 (Integer),\n \"placements\": [\n {\n \"job\": {\n \"id\": 6 (Integer)\n },\n \"prospect\": {\n \"id\": 30 (Integer)\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1 (Integer)\n },\n \"revenue\": {\n \"number\": 0, (Integer)\n \"pct\": 12 (Integer)\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32 (Integer)\n }\n ],\n \"pay_rate\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n \"frequency\": {\n \"name\": \"hour\" (String)\n }\n },\n \"bill_rate\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n \"frequency\": {\n \"name\": \"hour\" (String)\n }\n },\n \"work_quantum\": {\n \"number\": 1 (Integer)\n \"unit\": {\n \"name\": \"hour\" (String)\n },\n \"frequency\": {\n \"name\": \"hour\" (String)\n }\n \"is_full_time\": false (Boolean)\n },\n \"job_start_date\": \"2023-02-14\", (String)\n \"note\": \"\", (String)\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\" (String, Currency code eg. USD, GBP), \"number\": 600000 (float)}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\" (String), \"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"] (list of strings)\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\" (String)\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}\n```\n","parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"user_id\": 1,\n \"placements\": [\n {\n \"job\": {\n \"id\": 6\n },\n \"prospect\": {\n \"id\": 30\n },\n \"revenue\": {\n \"currency\": \"USD\",\n \"number\": 0\n },\n \"salary\": {\n \"currency\": \"USD\",\n \"number\": 0\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1\n },\n \"revenue\": {\n \"number\": 0,\n \"pct\": 12\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32\n }\n ],\n \"billing_date\": null,\n \"contract_start_date\": null,\n \"contract_end_date\": null,\n \"pay_rate\": {\n \"currency\": \"USD\",\n \"number\": 56546,\n \"frequency\": {\n \"name\": \"hour\"\n }\n },\n \"bill_rate\": {\n \"currency\": \"USD\",\n \"number\": 56546,\n \"frequency\": {\n \"name\": \"hour\"\n }\n },\n \"work_quantum\": {\n \"number\": 1,\n \"unit\": {\n \"name\": \"day\"\n },\n \"frequency\": {\n \"name\": \"week\"\n },\n \"is_full_time\": false\n },\n \"bonus\": {\n \"currency\": \"USD\",\n \"number\": 0\n },\n \"job_start_date\": \"2023-02-14\",\n \"success_fee\": {\n \"currency\": \"USD\",\n \"number\": 0\n },\n \"note\": \"\",\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\", \"number\": 600000}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\", \"number1\": 600000, \"number2\": 800000}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000, \"number2\": 800000}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"]\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\"\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}"}},"schema":{"properties":{"placements":{"items":{"properties":{"bill_rate":{"properties":{"currency":{"type":"string"},"frequency":{"properties":{"name":{"type":"string"}},"type":"object"},"number":{"type":"integer"}},"type":"object"},"billing_date":{"type":"date"},"bonus":{"properties":{"currency":{"type":"string"},"number":{"type":"integer"}},"type":"object"},"contacts":{"items":{"properties":{"id":{"type":"integer"}},"type":"object"},"type":"array"},"contract_end_date":{"type":"date"},"contract_start_date":{"type":"date"},"custom_fields":{"description":"Please refer to doc above","items":{"properties":{"id":{"type":"integer"},"value":{"type":"string"}},"type":"object"},"type":"array"},"job":{"properties":{"id":{"type":"integer"}},"type":"object"},"job_start_date":{"type":"date"},"note":{"type":"integer"},"pay_rate":{"properties":{"currency":{"type":"string"},"frequency":{"properties":{"name":{"type":"string"}},"type":"object"},"number":{"type":"integer"}},"type":"object"},"prospect":{"properties":{"id":{"type":"integer"}},"type":"object"},"revenue":{"properties":{"currency":{"type":"string"},"number":{"type":"integer"}},"type":"object"},"revenue_split":{"items":{"properties":{"revenue":{"properties":{"number":{"type":"integer"},"pct":{"type":"integer"}},"type":"object"},"user":{"properties":{"id":{"type":"integer"}},"type":"object"}},"type":"object"},"type":"array"},"salary":{"properties":{"currency":{"type":"string"},"number":{"type":"integer"}},"type":"object"},"success_fee":{"properties":{"currency":{"type":"string"},"number":{"type":"integer"}},"type":"object"},"work_quantum":{"properties":{"frequency":{"properties":{"name":{"type":"string"}},"type":"object"},"is_full_time":{"type":"boolean"},"number":{"type":"integer"},"unit":{"properties":{"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"type":"array"},"user_id":{"type":"Integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"placement_id":1}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Create a placement.","tags":["Placement APIs"]}},"/api/external/placement-record/get":{"get":{"parameters":[{"example":10,"explode":true,"in":"query","name":"placement_id","required":false,"schema":{"type":"string"},"style":"form"},{"example":1,"explode":true,"in":"query","name":"detailed","required":false,"schema":{"type":"string"},"style":"form"},{"example":1,"explode":true,"in":"query","name":"user_id","required":false,"schema":{"type":"string"},"style":"form"},{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"bill_rate":{"currency":"USD","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":56546},"billing_date":null,"bonus":{"currency":"USD","number":null},"contacts":[{"email":null,"id":32,"img_link":null,"label":"jhcbvjh","name":"jhcbvjh","type":2,"value":32}],"contract_end_date":null,"contract_start_date":null,"id":418,"job":{"client_company":{"id":30860,"name":"Test company Varun"},"id":17114,"job_type":{"id":4,"name":"Temporary"},"job_visibility_id":6,"name":"ts test job"},"job_start_date":"2023-02-13","note":"","pay_rate":{"currency":"USD","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":56546},"prospect":{"id":30,"name":"yghj"},"retainer":{"currency":"USD","frequency":{"display_name":"net","id":1,"name":"net"},"number":4677576.0},"revenue":{"currency":"USD","number":0},"revenue_split":[{"revenue":{"number":0,"pct":12},"user":{"id":1}}],"salary":{"currency":"USD","number":null},"success_fee":{"currency":"USD","number":null},"user":{"id":102035},"version":{"id":420},"work_quantum":{"frequency":{"display_name":"week","id":2,"name":"week"},"is_full_time":false,"number":1,"unit":{"display_name":"days","id":2,"name":"day"}}}]}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Returns the placement info for specified placement record.","tags":["Placement APIs"]}},"/api/external/placement-record/list":{"get":{"parameters":[{"example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"example":1,"explode":true,"in":"query","name":"detailed","required":false,"schema":{"type":"string"},"style":"form"},{"example":1,"explode":true,"in":"query","name":"user_id","required":false,"schema":{"type":"string"},"style":"form"},{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"bill_rate":{"currency":"USD","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":56546},"billing_date":null,"bonus":{"currency":"USD","number":null},"contacts":[{"email":null,"id":32,"img_link":null,"label":"jhcbvjh","name":"jhcbvjh","type":2,"value":32}],"contract_end_date":null,"contract_start_date":null,"id":418,"job":{"client_company":{"id":30860,"name":"Test company Varun"},"id":17114,"job_type":{"id":4,"name":"Temporary"},"job_visibility_id":6,"name":"ts test job"},"job_start_date":"2023-02-13","note":"","pay_rate":{"currency":"USD","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":56546},"prospect":{"id":30,"name":"yghj"},"retainer":{"currency":"USD","frequency":{"display_name":"net","id":1,"name":"net"},"number":4677576.0},"revenue":{"currency":"USD","number":0},"revenue_split":[{"revenue":{"number":0,"pct":12},"user":{"id":1}}],"salary":{"currency":"USD","number":null},"success_fee":{"currency":"USD","number":null},"user":{"id":102035},"version":{"id":420},"work_quantum":{"frequency":{"display_name":"week","id":2,"name":"week"},"is_full_time":false,"number":1,"unit":{"display_name":"days","id":2,"name":"day"}}}],"total_items":1}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all placements in the account.","tags":["Placement APIs"]}},"/api/external/placement-record/update":{"post":{"description":"\n**The below table describes the required input without any job engagement type**\n\n|

    Params

    |

    Data Type

    |

    Required

    |\n| ------------------ | ------------------ | ----------------- |\n| job | object | True |\n| prospect | object | True |\n| revenue | object | optional |\n| salary | object | optional |\n| revenue_split | object | optional |\n| contacts | array | optional |\n| billing_date | date | True |\n| bonus | object | optional |\n| job_start_date | date | optional |\n| note | string | optional |\n| track_revenue | integer (0 or 1) | optional |\n| user_id | integer | True |\n| custom_fields | array | optional |\n\n**Sample Payload**\n```\n{\n \"user_id\": 1 (Integer),\n \"placements\": [\n {\n \"job\": {\n \"id\": 6 (Integer)\n },\n \"prospect\": {\n \"id\": 30 (Integer)\n },\n \"revenue\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"salary\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1 (Integer)\n },\n \"revenue\": {\n \"number\": 0, (Integer)\n \"pct\": 12 (Integer)\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32 (Integer)\n }\n ],\n \"billing_date\": \"2023-03-8\" (String),\n \"bonus\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"job_start_date\": \"2023-02-14\", (String)\n \"note\": \"\", (String),\n \"track_revenue\": 0/1, (Boolean)\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\" (String, Currency code eg. USD, GBP), \"number\": 600000 (float)}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\" (String), \"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"] (list of strings)\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\" (String)\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}\n```\n\n**The below table describes the required input based on job engagement type**\n\n**1 : Job Type Contingent**\n\n|

    Params

    |

    Data Type

    |

    Required

    |\n| ------------------ | ------------------ | ----------------- |\n| job | object | True |\n| prospect | object | True |\n| revenue | object | optional |\n| salary | object | optional |\n| revenue_split | object | optional |\n| contacts | array | optional |\n| billing_date | date | True |\n| bonus | object | optional |\n| job_start_date | date | optional |\n| note | string | optional |\n| track_revenue | integer (0 or 1) | optional |\n| user_id | integer | True |\n| custom_fields | array | optional |\n\n**Sample Payload**\n```\n{\n \"user_id\": 1 (Integer),\n \"placements\": [\n {\n \"job\": {\n \"id\": 6 (Integer)\n },\n \"prospect\": {\n \"id\": 30 (Integer)\n },\n \"revenue\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"salary\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1 (Integer)\n },\n \"revenue\": {\n \"number\": 0, (Integer)\n \"pct\": 12 (Integer)\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32 (Integer)\n }\n ],\n \"billing_date\": \"2023-03-8\" (String),\n \"bonus\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"job_start_date\": \"2023-02-14\", (String)\n \"note\": \"\", (String),\n \"track_revenue\": 0/1, (Boolean)\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\" (String, Currency code eg. USD, GBP), \"number\": 600000 (float)}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\" (String), \"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"] (list of strings)\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\" (String)\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}\n```\n\n**2 : Job Type Contract**\n\n|

    Params

    |

    Data Type

    |

    Required

    |\n| ------------------ | ------------------ | ----------------- |\n| job | object | True |\n| prospect | object | True |\n| revenue_split | object | optional |\n| contacts | array | optional |\n| contract_start_date| date | optional |\n| contract_end_date | date | optional |\n| pay_rate | date | optional |\n| bill_rate | date | optional |\n| work_quantum | date | optional |\n| bonus | object | optional |\n| note | string | optional |\n| track_revenue | integer (0 or 1) | optional |\n| user_id | integer | True |\n| custom_fields | array | optional |\n\n**Sample Payload**
    \n* __Allowed bill rate frequency__\n 1. hour\n 2. day\n 3. week\n 4. month\n* __Allowed pay rate frequency__\n 1. hour\n 2. day\n 3. week\n 4. month\n* __Allowed work quantum frequency__\n 1. day\n 2. week\n 3. month\n* __Allowed work quantum unit__\n 1. hour\n 2. day\n 3. week\n```\n{\n \"user_id\": 1 (Integer),\n \"placements\": [\n {\n \"job\": {\n \"id\": 6 (Integer)\n },\n \"prospect\": {\n \"id\": 30 (Integer)\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1 (Integer)\n },\n \"revenue\": {\n \"number\": 0, (Integer)\n \"pct\": 12 (Integer)\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32 (Integer)\n }\n ],\n \"contract_start_date\": \"2023-03-8\" (String),\n \"contract_end_date\": \"2023-03-8\" (String),\n \"pay_rate\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n \"frequency\": {\n \"name\": \"hour\" (String)\n }\n },\n \"bill_rate\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n \"frequency\": {\n \"name\": \"hour\" (String)\n }\n },\n \"work_quantum\": {\n \"number\": 1 (Integer)\n \"unit\": {\n \"name\": \"hour\" (String)\n },\n \"frequency\": {\n \"name\": \"day\" (String)\n },\n \"is_full_time\": false (Boolean)\n },\n \"bonus\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"note\": \"\", (String),\n \"track_revenue\": 0/1, (Boolean)\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\" (String, Currency code eg. USD, GBP), \"number\": 600000 (float)}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\" (String), \"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"] (list of strings)\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\" (String)\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}\n```\n\n**3 : Job Type Retained**\n\n|

    Params

    |

    Data Type

    |

    Required

    |\n| ------------------ | ------------------ | ----------------- |\n| job | object | True |\n| prospect | object | True |\n| salary | object | optional |\n| revenue_split | object | optional |\n| contacts | array | optional |\n| billing_date | date | True |\n| bonus | object | optional |\n| job_start_date | date | optional |\n| success_fee | object | optional |\n| retainer | object | optional |\n| note | string | optional |\n| track_revenue | integer (0 or 1) | optional |\n| user_id | integer | True |\n| custom_fields | array | optional |\n\n**Sample Payload**
    \n* __Allowed retainer frequency__\n 1. net\n 2. hour\n 3. day\n 4. month\n\n```\n{\n \"user_id\": 1 (Integer),\n \"placements\": [\n {\n \"job\": {\n \"id\": 6 (Integer)\n },\n \"prospect\": {\n \"id\": 30 (Integer)\n },\n \"salary\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1 (Integer)\n },\n \"revenue\": {\n \"number\": 0, (Integer)\n \"pct\": 12 (Integer)\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32 (Integer)\n }\n ],\n \"billing_date\": \"2023-03-8\" (String),\n \"bonus\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"job_start_date\": \"2023-02-14\", (String)\n \"success_fee\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n },\n \"retainer\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n \"frequency\": {\n \"name\": \"net\" (String)\n }\n },\n \"note\": \"\", (String),\n \"track_revenue\": 0/1, (Boolean)\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\" (String, Currency code eg. USD, GBP), \"number\": 600000 (float)}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\" (String), \"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"] (list of strings)\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\" (String)\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}\n```\n\n**4 : Job Type Temporary**\n\n|

    Params

    |

    Data Type

    |

    Required

    |\n| ------------------ | ------------------ | ----------------- |\n| job | object | True |\n| prospect | object | True |\n| revenue_split | object | optional |\n| contacts | array | optional |\n| pay_rate | date | optional |\n| bill_rate | date | optional |\n| work_quantum | date | optional |\n| job_start_date | date | optional |\n| note | string | optional |\n| track_revenue | integer (0 or 1) | optional |\n| user_id | integer | True |\n| custom_fields | array | optional |\n\n**Sample Payload**\n* __Allowed bill rate frequency__\n 1. hour\n 2. day\n 3. week\n 4. month\n* __Allowed pay rate frequency__\n 1. hour\n 2. day\n 3. week\n 4. month\n* __Allowed work quantum frequency__\n 1. day\n 2. week\n 3. month\n* __Allowed work quantum unit__\n 1. hour\n 2. day\n 3. week\n```\n{\n \"user_id\": 1 (Integer),\n \"placements\": [\n {\n \"job\": {\n \"id\": 6 (Integer)\n },\n \"prospect\": {\n \"id\": 30 (Integer)\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1 (Integer)\n },\n \"revenue\": {\n \"number\": 0, (Integer)\n \"pct\": 12 (Integer)\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32 (Integer)\n }\n ],\n \"pay_rate\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n \"frequency\": {\n \"name\": \"hour\" (String)\n }\n },\n \"bill_rate\": {\n \"currency\": \"USD\", (String, Currency code eg. USD, GBP)\n \"number\": 77688 (Integer)\n \"frequency\": {\n \"name\": \"hour\" (String)\n }\n },\n \"work_quantum\": {\n \"number\": 1 (Integer)\n \"unit\": {\n \"name\": \"hour\" (String)\n },\n \"frequency\": {\n \"name\": \"hour\" (String)\n }\n \"is_full_time\": false (Boolean)\n },\n \"job_start_date\": \"2023-02-14\", (String)\n \"note\": \"\", (String),\n \"track_revenue\": 0/1, (Boolean)\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\" (String, Currency code eg. USD, GBP), \"number\": 600000 (float)}\n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\" (String), \"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000 (Float), \"number2\": 800000 (Float)}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"] (list of strings)\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\" (String)\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}\n```\n","parameters":[{"example":"e0fb97af10fe90c9e4ead2492a12938b","explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"0":{"value":"{\n \"user_id\": 1,\n \"placements\": [\n {\n \"job\": {\n \"id\": 6\n },\n \"prospect\": {\n \"id\": 30\n },\n \"revenue\": {\n \"currency\": \"USD\",\n \"number\": 0\n },\n \"salary\": {\n \"currency\": \"USD\",\n \"number\": 0\n },\n \"revenue_split\": [\n {\n \"user\": {\n \"id\": 1\n },\n \"revenue\": {\n \"number\": 0,\n \"pct\": 12\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": 32\n }\n ],\n \"billing_date\": null,\n \"contract_start_date\": null,\n \"contract_end_date\": null,\n \"pay_rate\": {\n \"currency\": \"USD\",\n \"number\": 56546,\n \"frequency\": {\n \"name\": \"hour\"\n }\n },\n \"bill_rate\": {\n \"currency\": \"USD\",\n \"number\": 56546,\n \"frequency\": {\n \"name\": \"hour\"\n }\n },\n \"work_quantum\": {\n \"number\": 1,\n \"unit\": {\n \"name\": \"day\"\n },\n \"frequency\": {\n \"name\": \"week\"\n },\n \"is_full_time\": false\n },\n \"bonus\": {\n \"currency\": \"USD\",\n \"number\": 0\n },\n \"job_start_date\": \"2023-02-14\",\n \"success_fee\": {\n \"currency\": \"USD\",\n \"number\": 0\n },\n \"note\": \"\",\n \"track_revenue\": 1,\n \"custom_fields\": [\n {\n \"id\": 16,\n \"value\": {\"currency\": \"USD\", \"number\": 600000} \n },\n {\n \"id\": 17,\n \"value\": {\"currency\": \"USD\", \"number1\": 600000, \"number2\": 800000} \n },\n {\n \"id\": 19,\n \"value\": {\"number1\": 600000, \"number2\": 800000}\n },\n {\n \"id\": 20,\n \"value\": [\"choice1\", \"choice2\"]\n },\n {\n \"id\" : 33,\n \"value\" : \"Random\"\n },\n {\n \"id\" : 99,\n \"value\" : [{\"type\": \"candidate\", \"id\": 1}]\n },\n {\n \"id\" : 34,\n \"value\" : [{\"user_id\": 1}]\n }\n ]\n }\n ]\n}"}},"schema":{"properties":{"placements":{"items":{"properties":{"bill_rate":{"properties":{"currency":{"type":"string"},"frequency":{"properties":{"name":{"type":"string"}},"type":"object"},"number":{"type":"integer"}},"type":"object"},"billing_date":{"type":"date"},"bonus":{"properties":{"currency":{"type":"string"},"number":{"type":"integer"}},"type":"object"},"contacts":{"items":{"properties":{"id":{"type":"integer"}},"type":"object"},"type":"array"},"contract_end_date":{"type":"date"},"contract_start_date":{"type":"date"},"custom_fields":{"description":"Please refer to doc above","items":{"properties":{"id":{"type":"integer"},"value":{"type":"string"}},"type":"object"},"type":"array"},"job":{"properties":{"id":{"type":"integer"}},"type":"object"},"job_start_date":{"type":"date"},"note":{"type":"integer"},"pay_rate":{"properties":{"currency":{"type":"string"},"frequency":{"properties":{"name":{"type":"string"}},"type":"object"},"number":{"type":"integer"}},"type":"object"},"prospect":{"properties":{"id":{"type":"integer"}},"type":"object"},"revenue":{"properties":{"currency":{"type":"string"},"number":{"type":"integer"}},"type":"object"},"revenue_split":{"items":{"properties":{"revenue":{"properties":{"number":{"type":"integer"},"pct":{"type":"integer"}},"type":"object"},"user":{"properties":{"id":{"type":"integer"}},"type":"object"}},"type":"object"},"type":"array"},"salary":{"properties":{"currency":{"type":"string"},"number":{"type":"integer"}},"type":"object"},"success_fee":{"properties":{"currency":{"type":"string"},"number":{"type":"integer"}},"type":"object"},"track_revenue":{"description":"0 = do not track revenue, 1 = track revenue (defaults to 0 if omitted)","type":"integer"},"work_quantum":{"properties":{"frequency":{"properties":{"name":{"type":"string"}},"type":"object"},"is_full_time":{"type":"boolean"},"number":{"type":"integer"},"unit":{"properties":{"name":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"type":"array"},"user_id":{"type":"Integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"placement_id":1}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Update a placement.","tags":["Placement APIs"]}},"/api/external/reference/call-outcome/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":1,"name":"Busy"},{"id":2,"name":"Connected"},{"id":3,"name":"Left Voicemail"},{"id":4,"name":"No Answer"}]}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"This endpoint lists all call outcomes available","tags":["Other APIs"]}},"/api/external/reference/meeting-type/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":1,"name":"Screening"},{"id":2,"name":"Check-in"},{"id":3,"name":"Intake"},{"id":4,"name":"Candidate Discovery"},{"id":5,"name":"Offer Discussion"}]}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"This endpoint lists all meeting types available","tags":["Other APIs"]}},"/api/external/reference/phone-types":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":2,"name":"Home"},{"id":1,"name":"Mobile"},{"id":4,"name":"Other"},{"id":3,"name":"Work"}]}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"This endpoint lists all phone types available","tags":["Other APIs"]}},"/api/external/sequences/list":{"post":{"description":"
    Returns a paginated, filterable list of sequences with per-sequence
    performance `stats` and a `recipient_status` breakdown.

    Pagination is required: `current_page` is 1-based and `items_per_page` may be
    at most 100.

    Optional `filters` is a list of objects. Supported keys (valid ids come from
    the `/api/external/sequences/reference-data` endpoint):
    - `status` (values: list of status ids)
    - `sequence_type_ids` (values: list of sequence type ids)

    Optional `q` searches by sequence name. Optional `sort` is an object with
    `on` (one of `sequence_name`, `sequence_type`, `sequence_status`, `created_at`)
    and `order` (`ASC` or `DESC`); it defaults to newest first.
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"current_page":{"description":"1-based page number.","example":1,"type":"integer"},"filters":{"description":"Optional list of filter objects.","items":{"properties":{"key":{"example":"status","type":"string"},"values":{"example":[2,3],"items":{"type":"integer"},"type":"array"}},"type":"object"},"type":"array"},"items_per_page":{"description":"Records per page (maximum 100).","example":10,"type":"integer"},"q":{"description":"Optional case-insensitive search on the sequence name.","example":"Outbound","type":"string"},"sort":{"properties":{"on":{"example":"created_at","type":"string"},"order":{"example":"DESC","type":"string"}},"type":"object"}},"required":["current_page","items_per_page"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"created_at":"2026-06-01 10:15:00","id":42,"name":"Outbound - Senior Engineers","owner":{"id":3264,"name":"Jane Recruiter"},"recipient_status":{"detail":[],"total":12},"sequence_status":{"id":2,"name":"In Progress"},"sequence_type":{"id":1,"name":"Candidate"},"stats":[]}],"total_items":1}}}},"description":"Paginated list of sequences"},"400":{"content":{"application/json":{"schema":{"example":{"RESULT":"FAILURE","message":"current_page and items_per_page must be positive integers (items_per_page max 100)"}}}},"description":"Invalid pagination parameters"}},"summary":"List sequences created within Recruiterflow.","tags":["Sequence APIs"]}},"/api/external/sequences/recipients/add":{"post":{"description":"
    Enrols one or more prospects (candidates or contacts) into an existing
    sequence and launches the sequence for the newly added recipients.

    All `prospect_ids` must match the sequence's type (a Candidate sequence
    accepts only candidates, a Contact sequence only contacts). Because the API
    key is account-scoped rather than user-scoped, `user_id` is required and
    identifies the user recorded as performing the action; it must belong to
    your account.

    Prospects that are already enrolled (or whose launch fails) are reported
    under `recipient_failures` rather than being re-added.
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"prospect_ids":{"description":"Ids of the candidates/contacts to enrol.","example":[430489,430490],"items":{"type":"integer"},"type":"array"},"sequence_id":{"description":"Id of the sequence to add recipients to.","example":42,"type":"integer"},"user_id":{"description":"Id of the user performing the action (must be in your account).","example":3264,"type":"integer"}},"required":["sequence_id","prospect_ids","user_id"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"RESULT":"SUCCESS","added_count":1,"recipient_failures":[]}}}},"description":"Recipients processed"},"400":{"content":{"application/json":{"schema":{"example":{"RESULT":"FAILURE","message":"User with id 3264 is not present in your account"}}}},"description":"Validation error"}},"summary":"Add prospects to a sequence.","tags":["Sequence APIs"]}},"/api/external/sequences/recipients/remove":{"post":{"description":"
    Removes one or more prospects from a sequence, stopping any further steps
    for them. Recipients are identified by their `prospect_ids` (the same ids you
    used to add them). As with adding recipients, `user_id` is required and must
    belong to your account.

    Any requested prospect that is not enrolled in the sequence is a no-op.
    `requested_count` echoes the number of prospects submitted for removal.
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"application/json","explode":false,"in":"header","name":"content-type","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"prospect_ids":{"description":"Ids of the candidates/contacts to remove.","example":[430489],"items":{"type":"integer"},"type":"array"},"sequence_id":{"description":"Id of the sequence to remove recipients from.","example":42,"type":"integer"},"user_id":{"description":"Id of the user performing the action (must be in your account).","example":3264,"type":"integer"}},"required":["sequence_id","prospect_ids","user_id"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"RESULT":"SUCCESS","requested_count":1}}}},"description":"Recipients removed"},"400":{"content":{"application/json":{"schema":{"example":{"RESULT":"FAILURE","message":"Sequence with id 42 not found"}}}},"description":"Validation error"}},"summary":"Remove prospects from a sequence.","tags":["Sequence APIs"]}},"/api/external/sequences/reference-data":{"get":{"description":"
    Returns the lookup lists needed to build requests to the other sequence
    endpoints, in a single call:

    - `status`: the statuses a sequence can be in. These `id` values are what
    the `status` filter of `/api/external/sequences/list` expects. The
    internal \"Deleted\" status is intentionally excluded.
    - `type`: sequence targets (Candidate or Contact). These `id` values are
    what the `sequence_type_ids` filter of `/api/external/sequences/list`
    expects, and they determine which prospects may be added to a sequence.
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":{"status":[{"id":1,"name":"Draft"},{"id":2,"name":"In Progress"},{"id":3,"name":"Paused"},{"id":4,"name":"Archived"},{"id":5,"name":"Completed"},{"id":6,"name":"Scheduled"}],"type":[{"id":1,"name":"Candidate"},{"id":2,"name":"Contact"}]}}}}},"description":"Sequence reference data (statuses and types)"}},"summary":"Reference data for the sequence APIs.","tags":["Sequence APIs"]}},"/api/external/status/list":{"get":{"description":"Note: This API endpoint is deprecated and will be removed in future. Please use /api/external/client/status/list instead.
    ","parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"id":1,"name":"Prospect"},{"id":2,"name":"Lead"},{"id":3,"name":"In progress"},{"id":4,"name":"Won"},{"id":5,"name":"Lost"}],"total_items":5}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"Lists all Company statuses.","tags":["Client APIs"]}},"/api/external/tags/list":{"get":{"parameters":[{"description":"Number of records per page.","example":10,"explode":true,"in":"query","name":"items_per_page","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The page number.","example":1,"explode":true,"in":"query","name":"current_page","required":false,"schema":{"type":"string"},"style":"form"},{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total tags","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"id":1,"name":"Artificial Intelligence"},{"id":2,"name":"Computer Science"},{"id":3,"name":"Machine Learning"}],"total_items":3}}},"description":"Auto generated using Swagger Inspector"}},"summary":"List all tags for candidates and contacts.","tags":["Other APIs"]}},"/api/external/user/get":{"get":{"parameters":[{"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The integer ID for the user in Recruiterflow","example":12,"in":"query","name":"id","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"The email ID of the user in Recruiterflow","example":"email@mail.com","explode":true,"in":"query","name":"email","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"email":"test@outlook.com","first_name":"Manish","id":40201,"img_link":null,"last_name":"Kotian","middle_name":"","name":"Manish Kotian","roles":[{"id":1,"name":"Admin"}]}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"The User get endpoint allows you to search for a specific user based on email/id","tags":["User APIs"]}},"/api/external/user/list":{"get":{"parameters":[{"explode":false,"in":"header","name":"RF-Api-Key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Count of total records","example":true,"explode":true,"in":"query","name":"include_count","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"data":[{"email":"manish.kotian36@outlook.com","first_name":"Manish","id":40201,"img_link":null,"last_name":"Kotian","middle_name":"","name":"Manish Kotian","roles":[{"id":1,"name":"Admin"}]},{"email":"manish+1@recruiterflow.com","first_name":"Manish","id":40626,"img_link":null,"last_name":"Kotian","middle_name":"","name":"Manish Kotian","roles":[{"id":7,"name":"Contact"}]}],"total_items":2}}}},"description":"Auto generated using Swagger Inspector"}},"summary":"The Users endpoint allows you to export all user related information from Recruiterflow.","tags":["User APIs"]}}},"tags":[{"name":"Candidate APIs"},{"name":"Client APIs"},{"name":"Contact APIs"},{"name":"Deal APIs"},{"name":"Job APIs"},{"name":"Placement APIs"},{"name":"Campaign APIs"},{"name":"Sequence APIs"},{"name":"User APIs"},{"name":"Other APIs"}]}