Skip to main content

Developer Documentation

Welcome to the flair developer documentation. This section covers the various ways to extend and integrate with flair's platform, including REST APIs, Custom Metadata Types, and programmatic customization options.

Overview​

flair provides multiple ways for developers to extend and integrate with the platform:

  • REST APIs - Programmatically access and integrate flair's HR data with external systems
  • Custom Metadata Types - Configure platform behavior using Salesforce Custom Metadata Types
  • Extra Fields - Extend Employee Hub forms and tables with custom Salesforce fields

REST APIs​

flair provides RESTful APIs for various HR modules. All API requests require authentication using an API token. Include your token in the Authorization header of each request:

Authorization: Token your-api-token-here

Available APIs​

Recruiting API​

Access job postings and candidate data through our Recruiting API. This API allows you to:

  • Retrieve all open job positions
  • Fetch candidate information
  • Integrate with your career portal or applicant tracking systems

For detailed endpoint documentation, see the Recruiting API section below.

Rate Limits​

API requests are subject to rate limiting to ensure system stability. If you encounter rate limit errors, please contact support at hello@flair.hr.

Custom Metadata Types​

flair uses Salesforce Custom Metadata Types to allow developers to configure and extend platform behavior without modifying core code. This approach provides:

  • Version control - Metadata can be packaged and deployed
  • Environment-specific configuration - Different settings for sandbox vs production
  • No code changes - Extend functionality through configuration

Extra Fields​

Extra Fields is a powerful customization feature that allows you to add custom Salesforce object fields to the Employee Hub and other flair interfaces. Using Custom Metadata Types (flair__Extra_Form_Field__mdt and flair__Extra_Table_Field__mdt), you can:

  • Add custom fields to forms and tables
  • Control field visibility with conditional logic
  • Customize lookup references with dynamic SOQL filters
  • Override field requirements independently of Salesforce settings

For detailed documentation, see the Extra Fields section.

Support​

For developer support, questions, or to request API access credentials, please contact us at hello@flair.hr.