Changelog

All notable changes to the RecruitSome API will be documented here.

[1.1.0] - 2026-03-27

Added

• /candidates endpoint for listing candidates from a user's repository
• /candidates POST endpoint for creating candidates via resume upload
• Candidate list supports filtering by email (exact match), search, and status
• Asynchronous resume processing with AI-powered data extraction
• Optional intake creation during candidate submission
• Full MDX documentation for both endpoints

API Features

• User-scoped candidate repository (candidates associated with a specific user)
• Base64 encoded resume upload (PDF, DOC, DOCX up to 10MB)
• Background processing with assistant request notifications
• Duplicate candidate detection and resume review flow

[1.0.0] - 2024-01-20

Added

• Initial API release
• /vacancies endpoint for listing published vacancies
• /vacancies/{slug} endpoint for vacancy details
• Bearer token authentication
• Comprehensive filtering options:

- Location filter

- Department filter

- Search functionality

- Job type filtering

- Experience level filtering

• Pagination support (up to 100 items per page)
• Sorting options (published date, title, created date)
• View tracking for vacancy details
• Rate limiting (60 requests/minute)

API Features

• Multi-language support with ISO 639-1 language codes
• HTML content for job descriptions, requirements, and offers
• Metadata fields for custom integrations
• Header image URLs for visual content
• Language proficiency requirements
• Application URL tracking

Security

• Tenant-isolated data access
• API key authentication
• Secure token storage
• Rate limiting per API key

Version Policy

The RecruitSome API follows semantic versioning:

• Major version (1.x.x): Breaking changes
• Minor version (x.1.x): New features, backwards compatible
• Patch version (x.x.1): Bug fixes, backwards compatible

Breaking Change Policy

We are committed to API stability. When breaking changes are necessary:

1. Announcement: 90 days advance notice via email and documentation
2. Migration Period: Old version supported for 180 days minimum
3. Migration Guide: Detailed documentation for upgrading
4. Support: Direct assistance for enterprise customers

Deprecation Notices

Deprecated features will be marked in:

• API responses with deprecation headers
• Documentation with clear warnings
• Email notifications to affected API key holders

Stay Updated

• Email Updates: API key holders receive automatic notifications
• RSS Feed: Subscribe to https://app\.recruitsome\.com/changelog.rss
• Status Page: https://status.recruitsome.com