JUMP TOCTRL-/Apply APIOverviewApplication APICreate a New Candidate ApplicationpostGet application configuration for postinggetGet candidate statusgetApprovals APIOverviewapprovalsGet approval request by idgetGet comments for given approval requestgetAdd comment to given approval requestpostGet pending approvals requests where you are an approver.getCreate approval requestpostApprove the approval request by idpostReject the approval request by idpostAssessment Partner APIOverviewconfigurationget partner configurationgetsaves configuration for partnerputintegrationenable the company integrationpostresultupdates package resultpatchadd attachment to orderpostAssessment Partner ApplicationOverviewintegrationShows consent form on partner sidegetRemoves integration on partner sidedeletepackagesRetrieves a list of packagesgetRetrieves a package by idgetordersOrders assessment package for candidatepostOrders inline assessment package for candidateposttokenExchange credentials for an access tokenpostAssessments APIOverviewassessment ordersRetrieves all assessment orders for specified applicationgetAudit APIOverviewauditList audit eventsgetCandidates APIOverviewcandidatesAdd tags to a candidatepostGet tags for a candidategetUpdate tags for a candidateputDelete tags for a candidatedeleteGet Onboarding Status for a candidategetSet Onboarding Status for a candidateputGet Onboarding Status for a candidate associated with given jobgetSets Onboarding Status for a candidate associated with given jobputSearch candidatesgetCreate a new candidate and assign to a Talent PoolpostParse a resume, create a candidate and assign to a Talent Pool.postRequest consent from multiple candidatespostStatus of candidate consentgetCandidate consent decisionsgetGet details of a candidategetDelete CandidatedeleteUpdate candidate personal informationpatchGet list candidate's attachments.getAttach files to a candidate.postGet a candidate's attachment.getGet list of candidate's attachments in context of given job.getAttach file to candidate in context of given job.postGet candidate's attachment.getDelete attachment.deleteUpdate a candidate's statusputUpdate a candidate's status on primary assignmentputGet candidate's status historygetGet candidate's status history for a candidate's jobgetUpdate a candidate's sourceputGet candidate property values for a candidategetGet candidate property values for a candidate's jobgetAdd/update candidate properties valuesputAdd/update candidate property valueputAdd/update candidate property valueputGet candidate screening answers for a candidate's jobgetCreate a new candidate and assign to a jobpostParse a resume, create a candidate and assign to a job.postGet details of a candidate's application to a jobgetDelete candidate's application to a jobdeleteConfiguration APIconfigurationCreate access grouppostList access groupsgetGet access groupgetUpdate access groupputDelete access groupdeleteGet company informationgetGet a list of available job propertiesgetCreate a job propertypostGet job property by idgetUpdate a job propertypatchAdd a job property's translationspatchGet available job property valuesgetCreate a job property valuepostArchive a job property valuedeleteUnarchive a job property valueputUpdate a job property valuepatchAdd a job property value's translationspatchArchive a job property valueputUnarchive a job property valuedeleteActivate a job propertyputDeactivate a job propertydeleteGet job property's dependentsgetCreate job property dependentspostRemove job property's dependentdeleteGet dependent job property's valuesgetGet job property's dependent valuesgetAdd job property's dependent valuepostRemove job property's dependent values relationshipdeleteCreates departmentpostGet departmentsgetGet departmentgetGet list of hiring processgetGet hiring processgetGet a list of available offer propertiesgetGet a list of available candidate propertiesgetGet candidate property by idgetGet Candidate Property valuesgetCreate candidate property valuepostGet Candidate Property value by idgetUpdate candidate property value labelputRemove candidate property valuedeleteList candidate source types with subtypesgetList candidate sourcesgetGet a candidate sourcegetGet a candidate source by identifier.getGet rejection reasonsgetGet withdrawal reasonsget[BETA] Get available entity names for entity mappingget[BETA] Get entity mappings by entity name and configurationIdspost[BETA] Get entity mappings by entity name and entityIdspostOverviewEvent management APIOvervieweventsGet event's detailsgetUpdate eventputDelete eventdeleteAdd interviewers to event's sessionputRemove interviewers from event's sessiondeleteMove applicants from session to sessionputAdd applicants from event pool to sessionpostGet job's eventsgetCreate eventpostGet all applicants (both event-applicants-pool and session-applicants) for specified eventgetAdd applicants to event poolpostGet event's session detailsgetDelete event's sessiondeleteGet event's applicantsgetGet candidate eventsgetGet application eventsgetFeedOverviewfeedGet posting by idgetUpdate posting informationputGet a list of postingsgetInterviewsOverviewinterview typesRetrieves interview typesgetAdds interview types to already existing onespatchRemoves interview type with given namedeleteinterviewsRetrieves a list of interviewsgetCreates an interviewpostRetrieves an interviewgetModifies an interviewpatchDeletes an interviewdeletestatusesChanges a candidate's status.putChanges a interviewer's status in given timeslotputChanges a candidate's status in given timeslotputtimeslotsCreates a timeslotpostRetrieves a timeslotgetModifies a timeslotpatchDeletes a timeslotdeleteChanges no-show value in a timeslotpatchJobs APIOverviewjobsPositions for a jobgetCreate a new position for a jobpostGet a single positiongetUpdate positionputDelete positiondeleteFind and list job ads for a given jobgetCreate a new job adpostGet a job adgetUpdate a job adputPublishes a job adpostList publications for a job adgetUnpublish a job addeletePublishes a default job adpostUnpublishes a job from all sourcesdeleteFind and list publications for a jobgetGet hiring team of a job with a given id.getAdd hiring team member of a job with a given id.postRemoves hiring team member of a job with a given id.deleteGet note of a job.getUpdate note of a job.putUpdate job headcount.patchSearch jobsgetCreate a new jobpostGet content of a job with a given id.getUpdate a jobpatchUpdates jobputUpdates job statusputJob status historygetGet latest approval request for given jobgetJob Applications APIOverviewjob-applicationsGet a job applicationgetDelete a job applicationdeleteMessages APIOverviewmessagesShares new messages on Hireloop with Users, Hiring Teams or Everyone and sends emails.postDelete a messagedeleteFetch messagesgetMessage templates APIOverviewmessage-templatesGet a message template by id.getUpdate Message TemplateputRemove a message template by id.deleteGet Message TemplatesgetCreate Message TemplatepostOffers API - version 1OverviewoffersGet candidate's offersgetGet candidate's offergetGet latest approval request for candidate's offergetSearch offersgetGet a list of documents related to sent offer.getGet a given document in a given sent offergetpartners-public-api (deprecated)OverviewconfigsFetch list of vendor configsgetAdd new configpostGet config for vendorgetUpdate configpostoffersSearch offers by criteriagetassessmentsGet Assessment orders by criteriagetGet Assessment Order by idgetPosting API - version 1OverviewpostingsLists active postings published by given companygetGet posting by posting id or uuid for given companygetList departments for given companygetReporting APIOverviewfilesGet report filegetDownload report filegetreportsGet report filesgetGenerate ad-hoc reportpostGet reportsgetGet reportgetGet most recent report filegetDownload most recent report filegetReviewsOverviewreviewsRetrieves all reviews for specified candidate and jobgetCreates a reviewpostRetrieves a reviewgetUpdates a reviewpatchDeletes a reviewdeletescorecardsRetrieves all criteria for specified jobgetSmartOnboardOverviewnew-hiresReturns details for a single New Hiregetonboarding-processesReturns details of a single Onboarding ProcessgetassignmentsReturns Assignments associated with a single Onboarding ProcessgetReturns specific Assignment associated with a single Onboarding Processgetassignments-submissionsReturns answers submitted for a single Web Form AssignmentgetReturns metadata for the fields that belong to a single Web Form AssignmentgetReturns answers submitted for a single Fillable PDF Form AssignmentgetReturns list of Attachments submitted for a single Activity AssignmentgetReturns single Attachment for specific Activity AssignmentgetUsers APIOverviewusersList users of your companygetCreate a new user.postGet details of my usergetGet details of a user with given idgetUpdate a userpatchSend a password reset email to a userpostSend an activation email to a userpostActivate a userputDeactivate a userdeleteUpdate user avatarputList system rolesgetList access groups configured in your companygetRemove user from access groupdeleteAssign users to access grouppostUsers API (Deprecated)OverviewusersList users of your companygetCreate a new userpostGet details of my usergetGet details of a user with given idgetDeactivate a userdeleteUpdate a userpatchSend an activation email to a userpostActivate a userputDeactivate a userdeleteUpdate user avatarputWebhooksOverviewsubscriptionsSubscribe to a webhook.postRetrieve webhook subscriptions.getRetrieve single webhook subscription.getDelete webhook subscription.deleteActivate webhook subscription.putGenerate a secret key for a webhook subscription.postRetrieve subscription secret keygetRetrieve callback request details starting from the newest.getSelf Scheduling APIself-schedulesUpdate a self schedule interviewputCreate a self schedule interviewpostCreates automated self schedule.postSearch for a self-scheduling instancesgetGets self schedule by idgetCancels self scheduledeleteRetrieve application-related details for a self-scheduling instancegetGet self-schedule slots for applicationgetUrl shortener APIshortenerShorten URLpostInterview Templates APIOverviewinterview-templatesGet managed hiring process steps for the job.getUpdate managed steps for the job.putGet interview template by id.getUpdate interview template by id.putRemove interview template by id.deleteUpdate job interview template.putUpdate interviewers selection for job interview template.patchSearch for all interview templates.getCreate interview template.postFind interview templates for the jobgetFind interview templates for job application id.getschedule-preferencesFind schedule preferencesgetApps Integrations APIOverviewpartner-apiEnables integrationpostCreate a new jobpost https://api.smartrecruiters.com/jobsCreate a new job. Ignores all nonexistent job properties and job properties values.Log in to see full request historyURL ExpiredThe URL for this request expired after 30 days.Body ParamsJob object that needs to be createdtitlestringrequiredlength between 1 and 256refNumberstringlength ≤ 63targetHiringDatedate-timedepartmentobjectdepartment objectlocationobjectrequiredlocation objectindustryobjectrequiredindustry objectfunctionobjectrequiredfunction objecttypeOfEmploymentobjecttypeOfEmployment objectexperienceLevelobjectrequiredexperienceLevel objecteeoCategoryobjecteeoCategory objecttemplatebooleantruefalsecompensationobjectcompensation objectjobAdobjectjobAd objectpropertiesarray of objectspropertiesADD objectResponses 201Created jobResponse bodyobjectidstringtitlestringrefNumberstringcreatedOndate-timeupdatedOndate-timeJob modification datelastActivityOndate-timeIndicates last activity associated with a jobdepartmentobjectidstringlabelstringrequireddescriptionstringlocationobjectcountrystringlength ≥ 1countryCodestringrequiredlength between 2 and 2regionCodestringregionstringcitystringrequiredlength ≥ 1addressstringpostalCodestringlongitudestringlatitudestringmanualbooleanremotebooleanstatusstringCREATED SOURCING FILLED INTERVIEW OFFER CANCELLED ON_HOLD OTHERpostingStatusstringPUBLIC INTERNAL NOT_PUBLISHED PRIVATEtargetHiringDatedate-timeindustryobjectidstringrequiredlength ≥ 1labelstringfunctionobjectidstringrequiredlength ≥ 1labelstringtypeOfEmploymentobjectidstringrequiredlength ≥ 1labelstringexperienceLevelobjectidstringrequiredlength ≥ 1labelstringeeoCategoryobjectidstringrequiredlength ≥ 1labelstringtemplatebooleancreatorobjectidstringfirstNamestringlastNamestringcompensationobjectmindouble | nullmaxdouble | nullcurrencystring | nulljobAdobjectsectionsobjectsections objectlanguageobjectlanguage objectpropertiesarray of objectspropertiesobjectidstringrequiredlength ≥ 1labelstringvalueobjectrequiredvalue objectactionsobjecthiringTeamobjecthiringTeam objectpublicationsobjectpublications objectpositionsobjectpositions objectapplyOnWebobjectapplyOnWeb objectdetailsobjectdetails object 400with codes DEPARTMENT_NOT_FOUND when provided department does not exist, INDUSTRY_NOT_FOUND when provided industry does not exist, FUNCTION_NOT_FOUND when provided function does not exist, TYPE_OF_EMPLOYMENT_NOT_FOUND when provided type of employment does not exist, JOB_AD_LANGUAGE_NOT_FOUND when provided job ad language does not exist, EEO_CATEGORY_NOT_FOUND when provided eeo category does not exist, EXPERIENCE_LEVEL_NOT_FOUND when provided experience level does not exist, CITY_NOT_FOUND when provided city does not exist, INVALID_GEO_DATA when latitude or longitude parameters are invalid JOB_PROPERTY_REQUIRED when some job property is required to create job, JOB_PROPERTY_PARENT_VALUE_MISSING when job property is set but value for its parent is missing, INVALID_JOB_PROPERTY_VALUE_ID when provided job property value id does not exist for required property, INVALID_JOB_PROPERTY_VALUE_TYPE when invalid value type is used for job property, JOB_PROPERTY_VALUE_NOT_AVAILABLE_FOR_SELECTED_PARENT_VALUE when job property's value is not available for selected parent value, VALUE_INACTIVE when job property's value is not active and cannot be set. INVALID_TEXT_FORMAT when job property's value contains invalid text INVALID_BRAND_VALUE when provided brand value is invalid TYPE_OF_EMPLOYMENT_NOT_ALLOWED when provided type of employment is not allowed in country Response bodyobjectmessagestringerrorsarray of objectserrorsobjectcodestringrequiredmessagestring 403with codes JOB_TEMPLATES_MANAGEMENT_FORBIDDEN when not allowed to create job templates. PERMISSION_DENIED when job access forbidden Response bodyobjectmessagestringerrorsarray of objectserrorsobjectcodestringrequiredmessagestring 409with code REF_NUMBER_ALREADY_EXISTS when provided ref number already exists Response bodyobjectmessagestringerrorsarray of objectserrorsobjectcodestringrequiredmessagestring 422Input validation failsUpdated over 1 year ago Search jobsGet content of a job with a given id.Did this page help you?YesNo
