Core Concepts

Welcome to the public API documentation. This page introduces the main terms and entities used across the system.

Main entities

• Employee - a system user, such as a recruiter or manager.
• Job - an open role in the company.
• Pipeline - a hiring pipeline made of multiple stages.
• Applicant - a person profile or resume stored in the system.
• Candidate - an applicant attached to a specific job.
• Actions - interaction history for a candidate, including stage changes, comments, and emails.
• Goals - company, team, or personal goals and metrics.

General API conventions

• /search endpoints are used for searching and always support pagination.
• Search endpoints return 20 items per page by default.
• /all endpoints return full reference lists.
• The API accepts and returns JSON data.

Technical parameters

• Authentication uses a bearer token.
• Standard HTTP status handling is expected, including 200, 401, 403, 404, 422, and 429.
• Token lifetime is 45 days.
• Rate limit is 100 requests per minute.
• Your integration should explicitly handle authentication, validation, and throttling errors.