100Hires - AI ATS & Recruitment Software

Add one or more tags to a candidate. Used for campaign tagging, qualification labels, and source attribution.

Add a company member to the job's hiring team. Use in workflow setup and ownership automation.

Advance an application to the next pipeline stage according to workflow order. No stage_id needed -- the system determines the next stage automatically. Always pass include=candidate,job when surfacing results in the widget — without it, the confirmation card can only show candidate/job IDs and cannot link to their backoffice pages.

Add tags to multiple candidates in one request (max 100). Returns per-item results with partial success support.

Create up to 100 scheduled messages in one request. Each item specifies its own candidate_id and message payload. Items are processed independently -- one failure does not stop others. Per-candidate RBAC is enforced for each item.

Get board publication states for multiple jobs in one request. Optimized for batch monitoring and management UIs.

Move multiple applications to a pipeline stage in one request. Returns per-item results with partial success support. Max 100 application IDs per request.

Activate board publication for multiple jobs in one request. Use for bulk job distribution workflows.

Reject multiple applications in one request with an optional rejection reason. Returns per-item results with partial success support. Max 100 application IDs per request.

Deactivate board publication for multiple jobs in one request. Use for bulk depublishing workflows.

Remove tags from multiple candidates in one request (max 100). Returns per-item results with partial success support.

Cancel all scheduled notification emails for a candidate. Already sent notifications are not affected. Returns success even if no scheduled notifications exist.

Create an application by linking an existing candidate to a job. Use for sourcing workflows and manual application ingestion. The candidate must already exist.

Create a new candidate profile. Optionally link to a job/stage and attach the candidate's resume as extracted text. Used for imports, inbound forms, and enrichment workflows. When the user provides an attached resume (PDF/DOCX/etc.), parse the file content yourself from the chat context — LLMs natively extract text from uploaded files — and pass the extracted text via resume_text. Do NOT attempt to inline binary file data: host function-call serializers truncate arguments above ~20KB.

Create a client company (partner tenant) — provisions its public career-site URL (slug) and public branding (logo, name). Typical entrypoint for multi-tenant onboarding.

Create a new email template with name, subject, and body. Subject and body support placeholders like {{first_name}}, {{job_title}}. To embed placeholders: 1) GET /template-placeholders to list them, 2) POST /template-placeholders/prepare to get the HTML tag, 3) insert the tag into the body.

Create a new application form, optionally attaching existing questions by ID.

Schedule a new interview for an application. Provide start/end times as Unix timestamps and a list of interviewer user IDs. Location is resolved to an existing record or created automatically.

Create a job with taxonomy, location, salary, and workflow configuration. Primary endpoint for programmatic job publishing. Required fields: status, title, description, location_city, location_country.

Register a webhook URL for job-related events. Core step for outbound integration setup. URL must be HTTPS. Returns a signing_secret once — store it to verify the x-hires-signature-v2 header on incoming deliveries.

Create a discussion note for a candidate. Supports visibility control (all or private) and @mentions with email notifications. Always pass include=candidate when surfacing results in the widget — without it, the confirmation card can only show the candidate ID and cannot link to their backoffice profile.

Create a nurture campaign with steps. Steps are executed sequentially; each step has a type (email, sms, voicemail, move_to_next_stage, assign_tag, assign_task) with type-specific fields. Optionally bind to a workflow stage.

Create a reusable question with optional answer options for dropdown types. Used by forms and questionnaires.

Create a company-scoped webhook subscription. Use for outbound company-level event integrations. Returns a signing_secret once — store it to verify the x-hires-signature-v2 header on incoming deliveries.

Permanently delete an application. This removes it from all list and view queries.

Permanently delete a candidate by ID or alias.

Delete (soft-delete) a company — takes its public career site offline. Use for lifecycle control in partner tenancy management.

Soft-delete an email template. Templates already used in automations will stop being available for new actions.

Delete an application form.

Delete a job. Use to align archived/removed positions across integrated platforms.

Delete a job webhook subscription by ID. Use for cleanup, rotation, and endpoint migration.

Cancel a scheduled message before it is processed by the mailbox scheduler.

Delete a note. Use for moderation policies and data cleanup operations.

Cancel a scheduled notification email before it is sent. Already sent messages cannot be canceled.

Delete (soft-delete) a nurture campaign. Active campaign executions will be stopped.

Delete a reusable question from the catalog. Use cautiously when deprecating question banks.

Delete a company-scoped webhook subscription by ID. Use for endpoint retirement and security rotation.

Disqualify a candidate from all active applications. Optionally provide rejection reason IDs. Returns affected application IDs.

Download an attachment (resume, candidate file, application file, mail attachment, call recording). Pass the absolute URL returned by another endpoint (e.g. message.attachments[].url, cv.url, resume.url) — it MUST belong to the configured 100Hires API host; other hosts are rejected to avoid leaking the Bearer token. Returns {file_name, mime_type, size, data} where data is base64-encoded bytes. Files larger than 25 MB are rejected up-front (Content-Length check / streaming abort) without being loaded into memory.

Get the structured AI score for an application, including per-criterion scores, justifications, and follow-up questions. Returns null score if the application has not been AI-scored.

Get full application details including stage, status, and rejection context. Recommended before mutating stage transitions.

Get billing/pricing capability flags for the current company. Use before invoking paid-only API behaviors.

Get full candidate data including application summaries by candidate ID or alias.

Get the primary resume for a candidate. Returns uuid, absolute download url (use Bearer auth), relative_time, file metadata, type. Use include='text_content' to also get the parsed plain-text content in a text field without downloading the file.

Get full details of a single public job by ID. Returns salary, education level, experience level, and other extended fields. Returns 404 for draft, archived, or internal jobs.

Get company profile and owner metadata. Use before updates or ownership-sensitive actions.

Get full details of a specific email template by ID, including subject and body content.

Get a filled evaluation form with all answers. Returns evaluator info, summary score, summary text, and individual question answers. Use for detailed review of evaluator feedback on a candidate application.

Get form details including all questions with their statuses.

Get full details of a specific interview by ID. Use include to embed related candidate, application, or job data.

Get full details of a job by ID or alias. Use include to load related workflow, hiring team, or pipeline stages data.

Get a scheduled message by ID. Returns scheduler-backed message details including sender account, schedule timestamps, and cancelability.

Get a single note with author and visibility metadata. Use include=user to load author details.

Get a notification email message (e.g. rejection email) by ID. Returns subject, body, sender, recipient, and schedule metadata. Use candidate messages list to discover notification message IDs.

Get a single nurture campaign by ID with all steps and configuration details.

Get a question definition including type and options by ID.

Get a single user by ID within current tenant scope. Use for identity resolution in automation flows. The default_mail_account_id field can be used as from_account_id when sending emails.

Get stages for a specific workflow by ID. Equivalent to hires_list_workflow_stages with workflow_id filter.

Mark an application as hired. This is the finalization step in a hiring workflow. The application status changes to 'hired' and hired_at is set.

List all file attachments linked to an application (resumes, cover letters, documents). Returns file metadata and download URLs.

List all filled evaluation forms for an application. Each evaluation includes the evaluator, summary score (strong-yes to strong-no), and summary text.

List applications across all accessible jobs. Supports filtering by candidate, job, stage, status, AI score range, and date ranges. Use for pipeline analytics, sync jobs, and ATS dashboards. Avoid include=candidate or include=cv.text on large pages (each embeds heavy nested data); if the response exceeds the budget the tool returns isError:true with error_code=response_too_large and retry hints. Each application embeds its current stage (IdName) directly in the response — this is sufficient for rendering kanban/pipeline views; you DO NOT need to call hires_get_job to fetch workflow_stages separately when rendering a pipeline.

Get the full chronological stage transition history for an application, including the initial assignment. Each entry has from_stage_id/name, to_stage_id/name, moved_at (Unix seconds), moved_by_type (system, user, automation), moved_by_user_id, and source (what caused the transition, e.g. 'apply:indeed', 'form_watcher', 'user'; null for historical records). Use this for funnel analysis, attribution reports, and time-in-stage reports instead of paginating through /candidates/{id}/activities when only stage data is needed.

List available publishing boards with metadata. Use for distribution setup and board selection.

List timeline activities for a candidate (comments, stage moves, AI responses, etc.). Supports filtering by event type. Recommended size <= 10: copilot responses and call transcriptions can be large per event; if the response exceeds the budget the tool returns isError:true with error_code=response_too_large and retry hints.

List all files attached to a candidate (resumes and other documents). Each entry has uuid, absolute download url (use Bearer auth), relative_time, file metadata (orig_file_name, file_ext, file_type/MIME, readable_size), and type (resume/other). Default response is compact; avoid include=text_content on candidates with many files — it adds parsed resume text per file which can exceed the response budget.

List all interviews for a candidate across all applications. Useful for timeline views and scheduling conflict detection.

List email and messaging history for a candidate. Use is_scheduled=1 to filter only pending scheduled messages. Recommended size <= 10: messages include full HTML body; if the response exceeds the budget the tool returns isError:true with error_code=response_too_large and retry hints.

List candidates with optional filters. Supports filtering by job, stage, email, name, LinkedIn, and date ranges. Returns paginated results. Recommended size <= 10: candidate payloads include the full profile answers array and can be large; if the response exceeds the budget the tool returns isError:true with error_code=response_too_large and retry hints — reduce size, narrow filters, or fetch a single record via hires_get_candidate.

List all tags assigned to a candidate. Useful for segmentation and audience-based automations.

List publicly visible jobs for a company career site. Supports filtering by department, employment type, city, and country. Use to power a custom careers page.

List global job categories. Use for job classification and consistent taxonomy mapping.

List partner-accessible companies with pagination. Use for tenant discovery and management panels.

List all mail accounts for all users in a specific company. The company must be accessible (own company or a client).

List all mail accounts for all users in the current company. Use to resolve from_account_id before creating scheduled emails.

List departments for the company. Use for job organization filters and reporting dimensions.

List education level taxonomy values. Useful for job requirements and structured matching.

List email templates for the target company. Returns paginated results with template name, subject, and body. Recommended size <= 10: templates include the full HTML body; if the response exceeds the budget the tool returns isError:true with error_code=response_too_large and retry hints — reduce size or fetch a single template via hires_get_email_template.

List supported employment types (full-time, part-time, contract, etc.). Use for validation and normalization.

List experience level taxonomy values for role seniority modeling.

List application forms (paginated). Returns forms with their questions for the target company. Recommended size <= 10: each form embeds its full question list; if the response exceeds the budget the tool returns isError:true with error_code=response_too_large and retry hints.

List users currently assigned to a job's hiring team. Useful for notification routing and collaboration tooling.

List interviews with optional filters by job, application, candidate, interviewer, date, or timestamps for incremental sync. Returns paginated results. Always pass include=candidate when surfacing results in the agenda widget — without it, the widget can only show candidate IDs and cannot link cards to candidate profiles. Avoid include=job on large pages (embeds full job description per interview); if the response exceeds the budget the tool returns isError:true with error_code=response_too_large and retry hints.

Get current board publication state for a specific job. Returns which job boards the job is published to. Useful for distribution dashboards and posting audits.

List jobs with optional filters by status, date range, department, or search query. Returns paginated results. Use for career-site sync, reporting, and external system indexing. Recommended size <= 10: full job payloads include description HTML and can be large; if the response exceeds the budget the tool returns isError:true with error_code=response_too_large and retry hints — reduce size, narrow filters, or fetch a single record via hires_get_job.

List webhooks configured for job-level events. Use to audit subscriptions and deployment state.

List messages sent or scheduled from a specific mail account. Returns outbound messages only (sent and scheduled), not received. Useful for monitoring cold outreach campaigns — check pending queue, delivery history, and plan next sends. Recommended size <= 10: messages include full HTML body; if the response exceeds the budget the tool returns isError:true with error_code=response_too_large and retry hints.

List notes by candidate. Returns paginated discussion notes for a candidate. Use for shared recruiter context and timeline synchronization. Notes can contain long free-form text; if the response exceeds the budget the tool returns isError:true with error_code=response_too_large and retry hints.

List nurture campaigns with pagination. Returns campaign summaries including steps.

List candidate origin taxonomy values. Use for attribution analytics and source normalization.

List paginated question catalog for the company.

List available question types supported by the platform. Use to drive dynamic form builders.

List configured rejection reasons for the company. Use to validate rejection actions and analytics.

List candidate sources for the company. Use for attribution sync and reporting consistency.

List job status labels (draft, published, on_hold, closed, archived). Cache to validate job status updates.

List all tags for the company. Returns paginated results. Recommended to cache for fast tagging UX.

List available placeholders for email templates with pagination. Use type to filter by category, q to search by label. Discover placeholders here, then use hires_prepare_template_placeholders to get an HTML tag for insertion.

List mail accounts connected to a user. Use to resolve from_account_id before creating scheduled emails via POST /candidates/{id}/messages.

List users for the target company with role context. Returns paginated results useful for access reviews and hiring-team management.

List webhook subscriptions configured at company scope.

List workflows with embedded stages for the company. Use to build stage-aware integrations and routing rules.

List pipeline stages filtered by workflow or job. Useful for transition UIs and workflow validation.

Moves an application to a specific pipeline stage for explicit stage transitions in workflow orchestration. Requires the target stage_id (available via the job's pipeline_stages).

Partially update a scheduled message before send time. Only provided fields are changed.

Convert a placeholder reference into an HTML tag for insertion into an email template body.

Activate selected job boards for a job. Sets boards to activation queue state. Use for controlled multi-board publishing workflows.

Reject an application with an optional rejection reason. Use GET /taxonomy/rejection-reasons to list available reason IDs. Set suppress_notification to skip the rejection email.

Remove a specific tag from a candidate.

Deactivate selected board publications for a job. Stops the job from being listed on specified boards.

Restore a previously deleted company and re-enable it for active use — its public career site comes back online. Use for recovery and rollback scenarios.

Rotate a job webhook's signing secret (zero-downtime). Returns the new signing_secret once; the previous secret stays valid for a grace window so deliveries are not dropped while you switch over.

Rotate a company webhook's signing secret (zero-downtime). Returns the new signing_secret once; the previous secret stays valid for a grace window so deliveries are not dropped while you switch over.

Schedule an email message to a candidate. If scheduled_at is omitted, the message is scheduled for 15 minutes after creation.

Change job status via dedicated endpoint. Recommended for publish/unpublish/archive transitions and status automation workflows.

Submit a job application on behalf of a candidate. Creates a candidate record and triggers the career-site pipeline automation.

Submit structured API feedback about missing features, issues, or workflow improvements. Rate limited to 5 requests per hour.

Transfer an application to another job. A new application is created on the target job. Optionally specify a stage on the target job's pipeline.

Undo a rejection and reopen a previously rejected application. The status returns to active and rejected_at is cleared.

Update application fields such as stage, disqualification flag, and CV. For explicit stage transitions prefer hires_move_application or hires_advance_application.

Update candidate fields, profile answers, and optional resume text. Used for bi-directional sync from ATS, CRM, sourcing, or enrichment tools. When the user provides an attached resume, parse it yourself from chat context and pass via resume_text — do not inline binary data.

Update company profile, owner contact data, and optional logo — changes the tenant's public career-site URL (slug), name, and logo (public branding). Supports partner-operated account management.

Update an existing email template. Only provided fields are overwritten; omitted fields keep their current values. To add placeholders, use the same workflow as creation.

Update form name and question composition.

Update the status (required/optional/hidden) of a question inside a form.

Update mutable job attributes. Only send fields you want to change. Preserves domain-level validation rules.

Fully update (replace) a scheduled message before send time. All required fields must be provided.

Update note body and/or visibility without creating a new timeline item. Use for corrections and moderation workflows.

Update a scheduled notification email before it is sent. Change subject, body, and optionally reschedule the send time. Only scheduled (not yet sent) messages can be updated.

Update an existing nurture campaign. Pass all steps -- mark removed steps with is_deleted=true. Existing steps must include their id.

Update text, type, or options of an existing question definition.

Upload a file attachment to an application. Provide the file as base64-encoded data. Commonly used for signed documents and interviewer artifacts.

Upload a file and create an attachment. Supported categories: voicemail (wav/mp3, max 20 MB, no object_id — returned uuid is usable as attachment_uuid in nurture voicemail steps); candidate (candidate ID); application (application ID); candidate_comment (comment ID); job_note (job-note ID); company_favicon/company_header/company_link_preview (company ID). Object ownership is strictly verified against the authenticated API key's company. Returns {uuid, url, file, relative_time}.

Upload a file for a candidate using a base64 payload. Used for portfolio uploads and document attachment. WARNING: host function-call serializers (both OpenAI and Anthropic) truncate tool arguments above ~20KB, so binary files larger than that will arrive corrupted. For resumes specifically, prefer hires_create_candidate / hires_update_candidate with resume_text — the model parses the file from chat context and passes extracted text, avoiding the size limit entirely.