For AI agents: visit https://developers.smartrecruiters.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
The SmartRecruiters API Platform
GuidesAPI ReferenceChangelog
The SmartRecruiters API Platform
Guides
GuidesAPI ReferenceChangelog

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 General Partner Integration
    • OAuth 2.0. Register an app
  • Access Scopes
    • Permission Reference
  • Pagination
  • Rate Limiting
  • Error Handling
  • Public IP addresses
  • Breaking Changes

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
  • Offer API
    • List 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
  • Interview API
    • Self Scheduling API
    • Interview Templates API
  • 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

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

MCP Server

  • MCP

Partner Endpoints Specification

Please see more at: Assessment Partner Application Specification

Updated 6 months ago


SmartRecruiters Endpoints Specification
Job Board API