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

Introduction

  • The SmartRecruiters API Platform
  • Get Started
  • API Reference

Overview

  • Authentication
    • API Key
    • Partner API Key
    • OAuth 2.0. Client Credentials grant
    • OAuth 2.0. Authorization Code grant
    • OAuth 2.0. Register an app
  • Access Scopes
    • Permission Reference
  • Pagination
  • Rate Limiting
  • Error Handling

Marketplace API

  • Overview
    • Getting Started
    • Access Resources
  • Application API
    • Get Application Screening Questions and Privacy Policies
    • Post an Application
    • Get Candidate Application Status
  • Assessment API (2021)
    • Integration Workflow
    • Customer Experience
    • SmartRecruiters Endpoints Specification
    • Partner Endpoints Specification
  • Job Board API
    • Get job postings
    • Get existing contract details
  • Objects
    • Candidate
    • ContactPerson
    • Employee
    • Error
    • Job
    • Money
    • AssessmentOrder
    • AssessmentComment
    • AssessmentOrderNotification
    • AssessmentResult
    • AssessmentResultAttachment
    • Availability
    • Config
    • InlineAssessmentCandidate
    • InlineAssessmentCompany
    • InlineAssessmentJob
    • InlineAssessmentOrderResponse
    • InlineAssessmentOrderRequest
    • TargetMarket
    • Offer
    • Terms
  • Assessment API
    • List assessment orders
    • Get an assessment order
    • Register a notification url
    • Accept / Reject assessment orders
    • Add Comments to assessment orders
    • Submit assessment results
    • Attach files to results
    • Mark assessment orders as Complete
    • Sending test assessment orders
  • In-line Assessment API
    • Configure integration
    • In-line assessment ordering process
    • Submit assessment results
  • Offer API
    • Create an Offer
    • Get an Offer
    • Submit / Withdraw Offer
    • List Offers
  • Endpoints
    • /assessments
    • /configs
    • /offers
  • Help

Customer API

  • Overview
    • Throttling Policies
    • Deprecation and Sunset Policies
  • Important Customer API Updates
  • Application API
    • Get Application Screening Questions and Privacy Policies
    • Post an Application
    • Get Candidate Application Status
  • Posting API
    • Endpoints
    • Objects
  • Reporting API
    • Metadata endpoints
    • Data generation endpoint
    • Data transfer endpoints
  • Webhooks
    • Creating webhook subscriptions
    • Activating webhook subscriptions
    • Receiving webhook notifications
    • Managing webhook subscriptions
    • Webhooks security
    • Webhooks Demo App
    • Troubleshooting
  • Help

Common Elements

  • Overview
  • Endpoints
    • /functions
    • /departments
    • /industries
    • /levels
    • /typesOfEmployment
  • Objects
    • Company
    • CustomField
    • Department
    • Employee
    • ExperienceLevel
    • Function
    • Industry
    • ListResult
    • Location
    • TypeOfEmployment

Web Single Sign-On

  • Overview
  • Configuration
    • Active Directory Federation Service (ADFS) Configuration
  • Creating new SSO-enabled user
  • Updating ssoIdentifier

Partner Endpoints Specification

Suggest Edits

Please see more at: Assessment Partner Application Specification

Updated over 1 year ago