Jump to Content
The SmartRecruiters API Platform
GuidesAPI ReferenceChangelog
The SmartRecruiters API Platform
API Reference
GuidesAPI ReferenceChangelog

Apply API

  • Overview
  • Application API
    • Create a New Candidate Applicationpost
    • Get application configuration for postingget
    • Get candidate statusget

Approvals API

  • Overview
  • approvals
    • Get approval request by idget
    • Get comments for given approval requestget
    • Add comment to given approval requestpost
    • Get pending approvals requests where you are an approver.get
    • Create approval requestpost
    • Approve the approval request by idpost
    • Reject the approval request by idpost

Assessment Partner API

  • Overview
  • configuration
    • get partner configurationget
    • saves configuration for partnerput
  • integration
    • enable the company integrationpost
  • result
    • updates package resultpatch
    • add attachment to orderpost

Assessment Partner Application

  • Overview
  • integration
    • Shows consent form on partner sideget
    • Removes integration on partner sidedelete
  • packages
    • Retrieves a list of packagesget
    • Retrieves a package by idget
  • orders
    • Orders assessment package for candidatepost
    • Orders inline assessment package for candidatepost
  • token
    • Exchange credentials for an access tokenpost

Assessments API

  • Overview
  • assessment orders
    • Retrieves all assessment orders for specified applicationget

Audit API

  • Overview
  • audit
    • List audit eventsget

Candidates API

  • Overview
  • candidates
    • Add tags to a candidatepost
    • Get tags for a candidateget
    • Update tags for a candidateput
    • Delete tags for a candidatedelete
    • Get Onboarding Status for a candidateget
    • Set Onboarding Status for a candidateput
    • Get Onboarding Status for a candidate associated with given jobget
    • Sets Onboarding Status for a candidate associated with given jobput
    • Search candidatesget
    • Create a new candidate and assign to a Talent Poolpost
    • Parse a resume, create a candidate and assign to a Talent Pool.post
    • Request consent from multiple candidatespost
    • Status of candidate consentget
    • Candidate consent decisionsget
    • Get details of a candidateget
    • Delete Candidatedelete
    • Update candidate personal informationpatch
    • Get list candidate's attachments.get
    • Attach files to a candidate.post
    • Get a candidate's attachment.get
    • Get list of candidate's attachments in context of given job.get
    • Attach file to candidate in context of given job.post
    • Get candidate's attachment.get
    • Delete attachment.delete
    • Update a candidate's statusput
    • Update a candidate's status on primary assignmentput
    • Get candidate's status historyget
    • Get candidate's status history for a candidate's jobget
    • Update a candidate's sourceput
    • Get candidate property values for a candidateget
    • Get candidate property values for a candidate's jobget
    • Add/update candidate properties valuesput
    • Add/update candidate property valueput
    • Add/update candidate property valueput
    • Get candidate screening answers for a candidate's jobget
    • Create a new candidate and assign to a jobpost
    • Parse a resume, create a candidate and assign to a job.post
    • Get details of a candidate's application to a jobget
    • Delete candidate's application to a jobdelete

Candidate status Public API

  • candidate-status
    • Get candidate statusget
  • Overview

Event management API

  • Overview
  • events
    • Get event's detailsget
    • Update eventput
    • Delete eventdelete
    • Add interviewers to event's sessionput
    • Remove interviewers from event's sessiondelete
    • Move applicants from session to sessionput
    • Add applicants from event pool to sessionpost
    • Get job's eventsget
    • Create eventpost
    • Get all applicants (both event-applicants-pool and session-applicants) for specified eventget
    • Add applicants to event poolpost
    • Get event's session detailsget
    • Delete event's sessiondelete
    • Get event's applicantsget
    • Get candidate eventsget
    • Get application eventsget

Configuration API

  • configuration
    • Create access grouppost
    • List access groupsget
    • Get access groupget
    • Update access groupput
    • Delete access groupdelete
    • Get company informationget
    • Get a list of available job propertiesget
    • Create a job propertypost
    • Get job property by idget
    • Update a job propertypatch
    • Add a job property's translationspatch
    • Get available job property valuesget
    • Create a job property valuepost
    • Archive a job property valuedelete
    • Unarchive a job property valueput
    • Update a job property valuepatch
    • Add a job property value's translationspatch
    • Archive a job property valueput
    • Unarchive a job property valuedelete
    • Activate a job propertyput
    • Deactivate a job propertydelete
    • Get job property's dependentsget
    • Create job property dependentspost
    • Remove job property's dependentdelete
    • Get dependent job property's valuesget
    • Get job property's dependent valuesget
    • Add job property's dependent valuepost
    • Remove job property's dependent values relationshipdelete
    • Creates departmentpost
    • Get departmentsget
    • Get departmentget
    • Get list of hiring processget
    • Get hiring processget
    • Get a list of available offer propertiesget
    • Get a list of available candidate propertiesget
    • Get candidate property by idget
    • Get Candidate Property valuesget
    • Create candidate property valuepost
    • Get Candidate Property value by idget
    • Update candidate property value labelput
    • Remove candidate property valuedelete
    • List candidate source types with subtypesget
    • List candidate sourcesget
    • Get a candidate sourceget
    • Get a candidate source by identifier.get
    • Get rejection reasonsget
    • Get 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 entityIdspost
    • List career sites configurationsget
    • Get details of career site configurationget
  • Overview
  • predefined-locations
    • Get list of predefined locationsget
    • Create predefined locationpost
    • Remove multiple predefined locationsdelete
    • Get predefined location by idget
    • Update predefined locationput
    • Remove predefined locationdelete

Feed

  • Overview
  • feed
    • Get posting by idget
    • Update posting informationput
    • Get a list of postingsget

Interviews

  • Overview
  • interview types
    • Retrieves interview typesget
    • Adds interview types to already existing onespatch
    • Removes interview type with given namedelete
  • interviews
    • Retrieves a list of interviewsget
    • Creates an interviewpost
    • Retrieves an interviewget
    • Modifies an interviewpatch
    • Deletes an interviewdelete
  • statuses
    • Changes a candidate's status.put
    • Changes a interviewer's status in given timeslotput
    • Changes a candidate's status in given timeslotput
  • timeslots
    • Creates a timeslotpost
    • Retrieves a timeslotget
    • Modifies a timeslotpatch
    • Deletes a timeslotdelete
    • Changes no-show value in a timeslotpatch

Jobs API

  • Overview
  • jobs
    • Positions for a jobget
    • Create a new position for a jobpost
    • Get a single positionget
    • Update positionput
    • Delete positiondelete
    • Find and list job ads for a given jobget
    • Create a new job adpost
    • Get a job adget
    • Update a job adput
    • Publishes a job adpost
    • List publications for a job adget
    • Unpublish a job addelete
    • Publishes a default job adpost
    • Unpublishes a job from all sourcesdelete
    • Find and list publications for a jobget
    • Get hiring team of a job with a given id.get
    • Add hiring team member of a job with a given id.post
    • Removes hiring team member of a job with a given id.delete
    • Get note of a job.get
    • Update note of a job.put
    • Update job headcount.patch
    • Search jobsget
    • Create a new jobpost
    • Get content of a job with a given id.get
    • Update a jobpatch
    • Updates jobput
    • Updates job statusput
    • Job status historyget
    • Get latest approval request for given jobget

Job Applications API

  • Overview
  • job-applications
    • Get a job applicationget
    • Delete a job applicationdelete

Messages API

  • Overview
  • messages
    • Shares new messages on Hireloop with Users, Hiring Teams or Everyone and sends emails.post
    • Delete a messagedelete
    • Fetch messagesget

Message templates API

  • Overview
  • message-templates
    • Get a message template by id.get
    • Update Message Templateput
    • Remove a message template by id.delete
    • Get Message Templatesget
    • Create Message Templatepost

Offers API - version 1

  • Overview
  • offers
    • Get candidate's offersget
    • Get candidate's offerget
    • Get latest approval request for candidate's offerget
    • Search offersget
    • Get a list of documents related to sent offer.get
    • Get a given document in a given sent offerget

partners-public-api (deprecated)

  • Overview
  • configs
    • Fetch list of vendor configsget
    • Add new configpost
    • Get config for vendorget
    • Update configpost
  • offers
    • Search offers by criteriaget

Posting API - version 1

  • Overview
  • postings
    • Lists active postings published by given companyget
    • Get posting by posting id or uuid for given companyget
    • List departments for given companyget

Reporting API

  • Overview
  • files
    • Get report fileget
    • Download report fileget
  • reports
    • Get report filesget
    • Generate ad-hoc reportpost
    • Get reportsget
    • Get reportget
    • Get most recent report fileget
    • Download most recent report fileget

Reviews

  • Overview
  • reviews
    • Retrieves all reviews for specified candidate and jobget
    • Creates a reviewpost
    • Retrieves a reviewget
    • Updates a reviewpatch
    • Deletes a reviewdelete
  • scorecards
    • Retrieves all criteria for specified jobget

SmartOnboard

  • Overview
  • new-hires
    • Returns details for a single New Hireget
  • onboarding-processes
    • Returns details of a single Onboarding Processget
  • assignments
    • Returns Assignments associated with a single Onboarding Processget
    • Returns specific Assignment associated with a single Onboarding Processget
  • assignments-submissions
    • Returns answers submitted for a single Web Form Assignmentget
    • Returns metadata for the fields that belong to a single Web Form Assignmentget
    • Returns answers submitted for a single Fillable PDF Form Assignmentget
    • Returns list of Attachments submitted for a single Activity Assignmentget
    • Returns single Attachment for specific Activity Assignmentget

Users API

  • Overview
  • users
    • List users of your companyget
    • Create a new user.post
    • Get details of my userget
    • Get details of a user with given idget
    • Update a userpatch
    • Send a password reset email to a userpost
    • Send an activation email to a userpost
    • Activate a userput
    • Deactivate a userdelete
    • Update user avatarput
    • List system rolesget
    • List access groups configured in your companyget
    • Remove user from access groupdelete
    • Assign users to access grouppost

Users API (Deprecated)

  • Overview
  • users
    • List users of your companyget
    • Create a new userpost
    • Get details of my userget
    • Get details of a user with given idget
    • Deactivate a userdelete
    • Update a userpatch
    • Send an activation email to a userpost
    • Activate a userput
    • Deactivate a userdelete
    • Update user avatarput

Webhooks

  • Overview
  • subscriptions
    • Subscribe to a webhook.post
    • Retrieve webhook subscriptions.get
    • Retrieve single webhook subscription.get
    • Delete webhook subscription.delete
    • Activate webhook subscription.put
    • Generate a secret key for a webhook subscription.post
    • Retrieve subscription secret keyget
    • Retrieve callback request details starting from the newest.get

Self Scheduling API

  • self-schedules
    • Update a self schedule interviewput
    • Create a self schedule interviewpost
    • Creates automated self schedule.post
    • Search for a self-scheduling instancesget
    • Gets self schedule by idget
    • Cancels self scheduledelete
    • Retrieve application-related details for a self-scheduling instanceget
    • Get self-schedule slots for applicationget

Url shortener API

  • shortener
    • Shorten URLpost

Interview Templates API

  • Overview
  • interview-templates
    • Get managed hiring process steps for the job.get
    • Update managed steps for the job.put
    • Get interview template by id.get
    • Update interview template by id.put
    • Remove interview template by id.delete
    • Update job interview template.put
    • Update interviewers selection for job interview template.patch
    • Search for all interview templates.get
    • Create interview template.post
    • Find interview templates for the jobget
    • Find interview templates for job application id.get
  • schedule-preferences
    • Find schedule preferencesget

Apps Integrations API

  • Overview
  • partner-api
    • Enables integrationpost

Overview

OpenAPI Specification