{ "swagger": "2.0", "info": { "version": "v1", "title": "Hirebridge.API" }, "host": "api.hirebridge.com", "schemes": [ "https" ], "paths": { "/v1/candidates": { "get": { "tags": [ "Candidates" ], "summary": "Get a list of candidates with optional filter and sort order as well as an optional field list to return.", "operationId": "Candidates_GetList", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "fields", "in": "query", "description": "An optional list of fields to return. If omitted, only candidateid, email, firstname, lastname, jobapplyid, and jobid are returned.", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "An optional set of filters to limit the result set. Multiple filters are separated by an ampersand (&) and each filter specifies\r\na field name and value pair separated by an equals sign (=). You may specify a range or multiple discreet values for each filter. A filter of \r\nfirstname=john,jane will return the details for any candidate with the first name John or Jan. A filter of \r\ncapplicantid=12345-54321 will return ALL candidates that have ID's from (and including) 12345 through (and including) 54321. A more complicated filter might be \r\ninitialdate=1/1/2016-12/31/2016&jobdept=1010,1020. This will search for all candidates that applied in the year 2016 for jobs in departments with the value\r\n1010 OR 1020. For department values (or locations or types, etc.) please see our CodeList API.", "required": false, "type": "string" }, { "name": "sortOrder", "in": "query", "description": "Optional sort order for the output. If omitted the list will be by candidateid. You may specify multiple sort fields\r\nby separating them with a comma and you may specify descending sort by adding a space and DESC after the field name. Valid values for\r\nthis parameter are therefore \"lastname desc\" or \"initialdate desc,lastname,firstname\" or \"firstname,lastname\".", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Optional limit on the maximum number of candidates that will be returned. Since a large number of records could potentially be returned and, depending \r\non the data fields returned could take a significant amount of time, it is prudent to limit the result set to a reasonable number.", "required": false, "type": "integer", "format": "int32" } ], "responses": {} } }, "/v1/candidates/{candidateid}": { "get": { "tags": [ "Candidates" ], "summary": "Return details for a single candidate by their candidate id. This is the same as the GetList method but with a single candidate id.", "operationId": "Candidates_GetCandidateById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "candidateid", "in": "path", "description": "The candidateid for which to retrieve data", "required": true, "type": "string" } ], "responses": {} } }, "/v1/candidates/jobapplyid/{jobapplyid}": { "get": { "tags": [ "Candidates" ], "summary": "Retrieve a candidate's details by their jobapplyid. Each candidate in the Hirebridge system has both a candidateid and jobapplyid. While\r\ndifferent, they each represent the same candidate. The jobapplyid is often visible in the URL of candidate-related pages within the system\r\nwhereas the candidateid is not. However, most candidate-related API functions expect the candidateid as a parameter.", "operationId": "Candidates_GetCandidateByJobApplyId", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "jobapplyid", "in": "path", "description": "The jobapplyid of the candidate to retrieve", "required": true, "type": "string" } ], "responses": {} } }, "/v1/candidates/{candidateid}/activitylog": { "get": { "tags": [ "Candidates" ], "summary": "Get a list of all activity log entries for the specified candidate.", "operationId": "Candidates_GetCandidateActivityLog", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "candidateid", "in": "path", "description": "The candidateid for which to retrieve the activity log", "required": true, "type": "string" } ], "responses": {} } }, "/v1/candidates/{candidateid}/snapshot": { "get": { "tags": [ "Candidates" ], "summary": "Returns a snapshot of the candidate's information including work history, education, references, licenses, languages, and experience.\r\nThis provides you with the same information visible on the Snapshot tap in the candidate's profile in the Hirebridge system.", "operationId": "Candidates_GetCandidateSnapshot", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "candidateid", "in": "path", "description": "The candidateid for which to retrieve the snapshot", "required": true, "type": "string" } ], "responses": {} } }, "/v1/candidates/{candidateid}/interviews": { "get": { "tags": [ "Candidates" ], "summary": "Get a list of all upcoming and completed interviews for the specified candidate.", "operationId": "Candidates_GetCandidateInterviews", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "candidateid", "in": "path", "description": "The candidateid for which to retrieve the list of interviews", "required": true, "type": "string" } ], "responses": {} } }, "/v1/lists/{listtype}": { "get": { "tags": [ "Lists" ], "summary": "Get a code list", "operationId": "Lists_GetList", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "listtype", "in": "path", "description": "Code list type", "required": true, "type": "string", "enum": [ "activitylog_activitytype", "AllLogActions", "AllUsers", "AllUsersAndContacts", "AllUsersAndContactsEmail", "applicantjobhist_gendrop1", "applicantjobhist_gendrop2", "applicantlic_code", "applicantworkeligibletype", "applicant_eeoethnic", "applicant_eeoethnicgroup", "applicant_eeogender", "applicant_facility", "applicant_gendrop1", "applicant_gendrop10", "applicant_gendrop11", "applicant_gendrop12", "applicant_gendrop13", "applicant_gendrop14", "applicant_gendrop15", "applicant_gendrop16", "applicant_gendrop17", "applicant_gendrop18", "applicant_gendrop19", "applicant_gendrop2", "applicant_gendrop20", "applicant_gendrop21", "applicant_gendrop22", "applicant_gendrop23", "applicant_gendrop24", "applicant_gendrop25", "applicant_gendrop26", "applicant_gendrop27", "applicant_gendrop28", "applicant_gendrop29", "applicant_gendrop3", "applicant_gendrop30", "applicant_gendrop31", "applicant_gendrop32", "applicant_gendrop33", "applicant_gendrop34", "applicant_gendrop35", "applicant_gendrop36", "applicant_gendrop37", "applicant_gendrop38", "applicant_gendrop4", "applicant_gendrop5", "applicant_gendrop6", "applicant_gendrop7", "applicant_gendrop8", "applicant_gendrop9", "applicant_jobtypedesired", "applicant_lastgrade", "applicant_militarystatus", "applicant_religion", "applicant_securityclearance", "applicant_sexorientation", "applicant_workeligibility", "applications", "applicationtype", "approvalaction", "approvalapprovers", "approvalChains", "approvalChainsOffer", "approvalfinaljobstatus", "approvalofferapprovers", "approvalrolechain", "approvers", "AssignedReviewersForJobList", "bankaccounttype", "benefitsel", "campaign_campaign", "campaign_medium", "campaign_source", "CandidateAcknowledgements", "candidatetasks_Subtasks", "candidatetasks_TaskDescription", "candidate_tagdef", "careerbuilderindustrycode", "careerbuilderjobtypecode", "careerbuilderResultCodes", "contacts", "contacttype", "country", "customequations", "disposition_other", "DraftApprovers", "eeoethnic", "eeogender", "eeojob", "EmailCandidateAcknowledgements", "EmailCandidateInterviewConfirmation", "EmailCandidateInterviewInvite", "EmailCandidateOpenCallInvite", "EmailCandidateTemplates", "EmailHiringManagerSurvey", "EmailInterviewerConfirmation", "EmailTemplateApplicationConsent", "EmailTemplateAssessmentReq", "EmailTemplateEsignRequest", "EmailTemplateFeedBack", "EmailTemplateForward", "EmailTemplateGeneral", "EmailTemplateInterviewFeedback", "EmailTemplateInterviewService", "EmailTemplateInviteToApply", "EmailTemplateLogActionNotify", "EmailTemplateMilestoneNotify", "EmailTemplateNotify", "EmailTemplateOffer", "EmailTemplateOfferApproved", "EmailTemplateOfferDocLib", "EmailTemplateOfferLetterLib", "EmailTemplateOnboard", "EmailTemplateOnboardTask", "EmailTemplatePasswordReset", "EmailTemplateProspect", "EmailTemplateRegret", "EmailTemplateRegretPublic", "EmailTemplateReqApproved", "EmailTemplateTestInvite", "EmailTemplateType", "EmailTemplateWOTC", "EmailUserTemplates", "EmailVendorCommunication", "EmployeeReferralEvaluation", "EnhancedLoggingActions", "formfillerforms", "GeoLocCountry", "Groups", "gteapplicant_drop1", "gteapplicant_drop10", "gteapplicant_drop11", "gteapplicant_drop12", "gteapplicant_drop13", "gteapplicant_drop14", "gteapplicant_drop15", "gteapplicant_drop2", "gteapplicant_drop3", "gteapplicant_drop4", "gteapplicant_drop5", "gteapplicant_drop6", "gteapplicant_drop7", "gteapplicant_drop8", "gteapplicant_drop9", "gtehirecandidate_drop1", "gtehirecandidate_drop10", "gtehirecandidate_drop11", "gtehirecandidate_drop12", "gtehirecandidate_drop13", "gtehirecandidate_drop14", "gtehirecandidate_drop15", "gtehirecandidate_drop2", "gtehirecandidate_drop3", "gtehirecandidate_drop4", "gtehirecandidate_drop5", "gtehirecandidate_drop6", "gtehirecandidate_drop7", "gtehirecandidate_drop8", "gtehirecandidate_drop9", "gtejoblist_drop1", "gtejoblist_drop10", "gtejoblist_drop11", "gtejoblist_drop12", "gtejoblist_drop13", "gtejoblist_drop14", "gtejoblist_drop15", "gtejoblist_drop2", "gtejoblist_drop3", "gtejoblist_drop4", "gtejoblist_drop5", "gtejoblist_drop6", "gtejoblist_drop7", "gtejoblist_drop8", "gtejoblist_drop9", "gteoffer_drop1", "gteoffer_drop10", "gteoffer_drop11", "gteoffer_drop12", "gteoffer_drop13", "gteoffer_drop14", "gteoffer_drop15", "gteoffer_drop2", "gteoffer_drop3", "gteoffer_drop4", "gteoffer_drop5", "gteoffer_drop6", "gteoffer_drop7", "gteoffer_drop8", "gteoffer_drop9", "gteoffer_salesdrawterms", "gteoffer_workvisatype", "HBProcess", "hirecandidate_backgroundcheck", "hirecandidate_customonboardfilter", "hirecandidate_flsastatus", "hirecandidate_gendrop1", "hirecandidate_gendrop10", "hirecandidate_gendrop11", "hirecandidate_gendrop12", "hirecandidate_gendrop13", "hirecandidate_gendrop14", "hirecandidate_gendrop15", "hirecandidate_gendrop16", "hirecandidate_gendrop17", "hirecandidate_gendrop18", "hirecandidate_gendrop19", "hirecandidate_gendrop2", "hirecandidate_gendrop20", "hirecandidate_gendrop21", "hirecandidate_gendrop22", "hirecandidate_gendrop23", "hirecandidate_gendrop24", "hirecandidate_gendrop25", "hirecandidate_gendrop26", "hirecandidate_gendrop27", "hirecandidate_gendrop28", "hirecandidate_gendrop29", "hirecandidate_gendrop3", "hirecandidate_gendrop30", "hirecandidate_gendrop4", "hirecandidate_gendrop5", "hirecandidate_gendrop6", "hirecandidate_gendrop7", "hirecandidate_gendrop8", "hirecandidate_gendrop9", "hirecandidate_genevaplusjobtitlecode", "hirecandidate_genevaplussalarytype", "hirecandidate_hiretype", "hirecandidate_maritalstatus", "hirecandidate_payschedule", "hirecandidate_unhiredreason", "hiringmanager", "HiringManagerSurvey", "indeedquestionsets", "IndustryList", "interviewguideline", "interviewkit", "interviewkitv1", "interviewkitv2", "interview_candidatelocation", "interview_location", "Intranet", "jobapplysup_assessmentband2criteriacorp", "jobapplysup_gendrop1", "jobapplysup_gendrop10", "jobapplysup_gendrop2", "jobapplysup_gendrop3", "jobapplysup_gendrop4", "jobapplysup_gendrop5", "jobapplysup_gendrop6", "jobapplysup_gendrop7", "jobapplysup_gendrop8", "jobapplysup_gendrop9", "JobCodes", "jobcost_costitemcode", "jobcost_costtypecode", "jobdept", "joblist_additionalassessmentpactype", "joblist_appContactTemplateSlot", "joblist_apptemplateslot", "joblist_assessmentpactype", "joblist_bgcheckpactype", "joblist_businessunit", "joblist_busunit", "joblist_client", "joblist_copycand", "joblist_costcenter", "joblist_division", "joblist_gendrop1", "joblist_gendrop10", "joblist_gendrop11", "joblist_gendrop12", "joblist_gendrop13", "joblist_gendrop14", "joblist_gendrop15", "joblist_gendrop2", "joblist_gendrop3", "joblist_gendrop4", "joblist_gendrop5", "joblist_gendrop6", "joblist_gendrop7", "joblist_gendrop8", "joblist_gendrop9", "joblist_grade", "joblist_hiretype", "joblist_jobbranch", "joblist_jobcat", "joblist_jobcode", "joblist_jobcompany", "joblist_jobcurrencytype", "joblist_jobdistrict", "joblist_jobfacility", "joblist_jobfunction", "joblist_jobgroup", "joblist_jobindeedremotetype", "joblist_jobindustry", "joblist_jobpayrolldept", "joblist_jobsalarytype", "joblist_jobschoolname", "joblist_jobschoolyear", "joblist_positionstatus", "joblist_project", "joblist_quicktemplateslot", "joblist_reasonclosing", "joblist_reqtemplateslot", "joblist_subclient", "joblist_travel", "joblist_videointerviewpactype", "jobloc", "joblocwithusercode", "jobother", "jobpriority", "jobstatus", "jobstatus_all", "jobstatus_allAndDisable", "jobtitle_active", "jobtitle_all", "jobtitle_close", "jobtitle_template", "jobtype", "languages", "malefemale", "malefemaledecline", "milestonelogactiontype", "milestonestep", "milestonestepcompany", "months", "nextstep", "None", "notes", "notsureyesno310", "noyes", "noyes01", "oauth_providers", "offerstatus", "offer_offerrejectreason", "offer_packages", "onboard_gendrop1", "onboard_gendrop2", "onboard_gendrop3", "onboard_gendrop4", "onboard_gendrop5", "onboard_gendrop6", "onboard_gendrop7", "onboard_gendrop8", "onboard_packages", "onboard_scanneddocumenttype", "onetcodes", "paysel", "permissionall", "permissionhiringmgr", "permissionrecruiter", "pointhrclients", "PortfolioCompanies", "postto", "precheckclients", "privacypolicy", "pronouns", "qsetresponder", "questionset", "questionsetfeedback", "questionsetuser", "ranking", "recruiter", "recruiterhiringmgremail", "recruiterplusd", "referralsource_associate", "referralsource_employee", "referralsource_employeeemail", "referralsource_vendor", "rejection", "reqreason", "ReviewersForJobList", "source", "source_type", "source_typeused", "state", "status", "talentstage", "talentstatus", "TerminationReason", "truefalse", "type", "userroles", "usertasktype", "vetstatus", "vistabudgetedyesno", "wagenoticestates", "workflow", "workflowrequirements", "workflowsteptype", "years", "yearsattended", "yesno10", "yesno100_0", "yesnodecline" ] } ], "responses": {} } }, "/v1/milestones": { "get": { "tags": [ "Milestones" ], "summary": "Gets the milestones for all candidates based on the specified filters. You may specify a candidateid to filter by candidate (which is equivalent to the GET\r\nrequest that accepts candidateid in the request URL) or any of the other fields you will\r\nsee returned in this GET request. Because there may be many milestones, we limit the result set to 2,000 records.", "operationId": "Milestones_GetMilestonesForAll", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "query", "description": "An optional set of filters to limit the result set. Multiple filters are separated by an ampersand (&) and each filter specifies\r\na field name and value pair separated by an equals sign (=). You may specify a range or multiple discreet values for each filter. A filter of \r\nlogactioncodeid=1002,1004 will return the first 2,000 phone screen and department interview milestones in the system. \r\nA filter of logactioncodeid=1001-1004 will return the first 2,000 milestones types 1001 through 1004. \r\nA more complicated filter might be createdate=1/1/2016-12/31/2016&logactioncodeid=1002,1004. This will return the first 2,000 milestones\r\ncreated in the year 2016 of types 1002 and 1004. The milestone types can be found by using our Lists API and passing a listtype of milestonelogactiontype.", "required": false, "type": "string" }, { "name": "sortOrder", "in": "query", "description": "Optional sort order for the output. If omitted the list will be by createdate. You may specify multiple sort fields\r\nby separating them with a comma and you may specify descending sort by adding a space and DESC after the field name. Valid values for\r\nthis parameter are therefore \"milestonename desc\" or \"createdate desc,milestonename\" or \"milestonename,candidateid\"", "required": false, "type": "string" } ], "responses": {} } }, "/v1/milestones/{candidateid}": { "get": { "tags": [ "Milestones" ], "summary": "Gets the milestones for a candidate with the specified candidateid using the (optional) filters specified and output in the specified sort\r\norder. If no filter is specified all milestones for the candidates are returned. If no sort order is specified the sort order is by date created in\r\nascending order. For a list of possible milestone types (logactioncodeid) see the CodeList API and get type listtype milestonelogactiontype", "operationId": "Milestones_GetMilestonesForCandidate", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "candidateid", "in": "path", "description": "A candidate's applicant id as returned in a candidate search via our Candidates API.", "required": true, "type": "string" }, { "name": "filter", "in": "query", "description": "An optional set of filters to limit the result set. Multiple filters are separated by an ampersand (&) and each filter specifies\r\na field name and value pair separated by an equals sign (=). You may specify a range or multiple discreet values for each filter. A filter of \r\nlogactioncodeid=1002,1004 will return the first 2,000 phone screen and department interview milestones in the system meeting the filter criteria. \r\nA filter of logactioncodeid=1001-1004 will return the first 2,000 milestones types 1001 through 1004. \r\nA more complicated filter might be createddate=1/1/2016-12/31/2016&logactioncodeid=1002,1004. This will return the first 2,000 milestones\r\ncreated in the year 2016 of types 1002 and 1004. The milestone types can be found by using our CodeList API and passing a listtype of milestonelogactiontype.", "required": false, "type": "string" }, { "name": "sortOrder", "in": "query", "description": "Optional sort order for the output. If omitted the list will be by createdate. You may specify multiple sort fields\r\nby separating them with a comma and you may specify descending sort by adding a space and DESC after the field name. Valid values for\r\nthis parameter are therefore \"milestonename desc\" or \"createdate desc,milestonename\" or \"milestonename,candidateid\"", "required": false, "type": "string" } ], "responses": {} } }, "/v1/jobs": { "get": { "tags": [ "Requisitions" ], "summary": "Get a list of job requisitions with optional filter and sort order as well as an optional field list to return.", "operationId": "Requisitions_SearchReqsGet", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "fields", "in": "query", "description": "An optional list of fields to return. If omitted it will return jobid nad jobtitle as well as the \r\ncounts activecandidates and totalcandidates.", "required": false, "type": "string" }, { "name": "filter", "in": "query", "description": "An optional set of filters to limit the result set. Multiple filters are separated by an ampersand (&) and each filter specifies\r\na field name and value pair separated by an equals sign (=). As this is passed in a URL parameter it MUST be URL-encoded where an equals sign \r\nis replaced with %3D and an ampersand with %26. You may specify a range or multiple discreet values for each filter. A filter of \r\njobid=12345,54321 (encode the command as %2C) will return the details for 2 job reqs. A filter of jobid=12345-54321 will return ALL job\r\nreqs that have ID's from (and including) 12345 through (and including) 54321. A more complicated filter might be \r\ncreateddate=1/1/2016-12/31/2016&jobdept=1010,1020. This will search for all jobs created in the year 2016 for departments with the value\r\n1010 OR 1020. For department values (or locations or types, etc.) please see our CodeList API.", "required": false, "type": "string" }, { "name": "sortOrder", "in": "query", "description": "Optional sort order for the output. If omitted the list will be by joblistid. You may specify multiple sort fields\r\nby separating them with a comma (encoded) and you may specify descending sort by adding a space (encode as %20) and DESC after the field name. Valid values for\r\nthis parameter are therefore \"jobtitle desc\" or \"createdate desc,jobtitle\" or \"jobloc,jobdept,jobtitle\"", "required": false, "type": "string" } ], "responses": {} } }, "/v1/jobs/search": { "post": { "tags": [ "Requisitions" ], "summary": "Search for jobs using a POST method. This works just like the GET of job above but receives its parameters via the body of\r\nthe POST request. This is provided as an alternative for when the parameters of a GET might exceed the maximum length allowed\r\nfor a URL.", "operationId": "Requisitions_SearchReqsPost", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "searchParameters", "in": "body", "description": "A JSON object containing the parameters to pass to the search function. Please see the documentation\r\n to the GET /jobs method for details regarding each parameter.", "required": true, "schema": { "$ref": "#/definitions/ApiSearchParameters" } } ], "responses": {} } }, "/v1/jobs/{jobid}": { "get": { "tags": [ "Requisitions" ], "summary": "Get the details of a single job requisition", "operationId": "Requisitions_GetReq", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "jobid", "in": "path", "description": "The job requisition ID for which you want to receive the details", "required": true, "type": "string" } ], "responses": {} } }, "/v1/jobs/{jobid}/candidates": { "get": { "tags": [ "Requisitions" ], "operationId": "Requisitions_GetAllCandidateForJob", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "jobid", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": {} } }, "/v1/jobs/{jobid}/candidates/active": { "get": { "tags": [ "Requisitions" ], "operationId": "Requisitions_GetActiveCandidateForJob", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "jobid", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": {} } }, "/v1/jobs/{jobid}/candidates/unviewed": { "get": { "tags": [ "Requisitions" ], "operationId": "Requisitions_GetUnviewedCandidateForJob", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "jobid", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": {} } }, "/v1/jobs/{jobid}/candidates/unscreened": { "get": { "tags": [ "Requisitions" ], "operationId": "Requisitions_GetUnscreenedCandidateForJob", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "jobid", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": {} } }, "/v1/users": { "get": { "tags": [ "Users" ], "operationId": "Users_GetUsers", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "userType", "in": "query", "required": true, "type": "string", "enum": [ "HiringManagers", "StandardUsers", "StandardUsersAndHiringManagers" ] } ], "responses": {} }, "post": { "tags": [ "Users" ], "operationId": "Users_CreateUser", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "user", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserOrHiringManager" } } ], "responses": {} } }, "/v1/users/role/{roleId}": { "get": { "tags": [ "Users" ], "operationId": "Users_GetUsersInRole", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "roleId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": {} } }, "/v1/users/roles": { "get": { "tags": [ "Users" ], "operationId": "Users_GetUserRoles", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [], "responses": {} } }, "/v1/users/{userId}": { "get": { "tags": [ "Users" ], "operationId": "Users_GetUser", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user to be updated", "required": true, "type": "string" } ], "responses": {} }, "put": { "tags": [ "Users" ], "operationId": "Users_UpdateUser", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user to be updated", "required": true, "type": "integer", "format": "int32" }, { "name": "user", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserOrHiringManager" } } ], "responses": {} } }, "/v1/users/activate/{userId}": { "post": { "tags": [ "Users" ], "operationId": "Users_ActivateUser", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user to be updated", "required": true, "type": "integer", "format": "int32" }, { "name": "sendActivationEmail", "in": "query", "required": true, "type": "boolean" } ], "responses": {} } }, "/v1/users/deactivate/{userId}": { "post": { "tags": [ "Users" ], "operationId": "Users_DeactivateUser", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user to be updated", "required": true, "type": "integer", "format": "int32" } ], "responses": {} } }, "/v1/users/me/interviews": { "get": { "tags": [ "Users" ], "operationId": "Users_GetUserInterviews", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "StartDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "EndDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "MaxRows", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": {} } }, "/v1/users/me/interviews/{taskid}/feedback": { "get": { "tags": [ "Users" ], "operationId": "Users_GetInterviewFeedback", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "taskid", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": {} } }, "/v1/users/me/opencalls": { "get": { "tags": [ "Users" ], "operationId": "Users_GetOpenCalls", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "OpenCallDate", "in": "query", "required": true, "type": "string", "format": "date-time" } ], "responses": {} } } }, "definitions": { "ApiSearchParameters": { "type": "object", "properties": { "sortOrder": { "type": "array", "items": { "type": "string" } }, "filters": { "type": "array", "items": { "$ref": "#/definitions/ApiFieldParameter" } }, "fields": { "type": "array", "items": { "type": "string" } }, "limit": { "format": "int32", "type": "integer" } } }, "ApiFieldParameter": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldValue": { "type": "string", "readOnly": true } } }, "UserOrHiringManager": { "required": [ "userType", "firstName", "lastName", "email", "permissionGroupId" ], "type": "object", "properties": { "userType": { "enum": [ "StandardUser", "HiringManager" ], "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "jobTitle": { "type": "string" }, "permissionGroupId": { "format": "int32", "type": "integer" }, "ssoId": { "type": "string" }, "activated": { "type": "boolean" }, "sendActivationEmail": { "type": "boolean" }, "userRoles": { "type": "array", "items": { "format": "int32", "type": "integer" } } } } }, "securityDefinitions": { "apiKey": { "type": "apiKey", "description": "API Key Authentication", "name": "HBAPIKEY", "in": "header" } } }