100Hires Career Site API

openapi: 3.2.0
info:
  title: 100Hires Career Site API
  version: 2.0.0
  description: '## Introduction to the 100Hires ATS API

    The 100Hires ATS API (v2) helps you automate recruiting workflows end-to-end: candidates, applications, jobs, forms, notes, and partner-company operations. All endpoints return JSON and use bearer authentication. ## OpenAPI Spec

    The 100Hires ATS API follows the OpenAPI 3.x specification. Download the machine-readable spec for use in MCP servers, Cursor, Claude Code, or any OpenAPI tooling:


    `GET https://api.100hires.com/v2/openapi.json`


    ## Authentication

    Send API token in the `Authorization` header for every request:


    `Authorization: Bearer `


    Each API key is tied to a specific **user + company** pair. If the same user belongs to multiple companies, they need a separate key for each company. All actions performed through the API are attributed to the key owner. You can generate or view your API key at https://app.100hires.com/settings/integrations


    ### API Key Verification

    API keys for **unverified companies** are created in a disabled state and will return `401 Unauthorized` until the company passes verification. Once your company is verified, API keys start working automatically — no action required. If your key returns `401` and you believe your company should be verified, contact **support@100hires.com**. ## Rate Limits

    API keys that are not yet approved, such as keys created during the free trial, are subject to a hard rate limit of **1,000 requests per 10 minutes** per company. All API keys and MCP connections of a company share this limit. If your company is managed by a partner, it shares the partner''s limit. Personal API keys are approved automatically when the company starts a paid subscription. Requests over the limit receive a `429 Too Many Requests` response. ### Rate limit headers

    Unapproved keys include these headers on every response:


    | Header | Description |

    |--------|-------------|

    | `X-RateLimit-Limit` | Maximum requests allowed in the current window |

    | `X-RateLimit-Remaining` | Requests remaining in the current window |

    | `X-RateLimit-Reset` | Unix timestamp (seconds) when the window resets |


    ### Handling 429 responses

    When you receive a `429` response, wait until `X-RateLimit-Reset` before retrying. Do not retry immediately — repeated 429s may extend the cooldown. To remove rate limits for your integration, contact **support@100hires.com** with your use case. ## Content-Type

    All request bodies **must** use `Content-Type: application/json`. Sending `application/x-www-form-urlencoded`, `multipart/form-data`, or any other content type

    will result in a `415 Unsupported Media Type` error. ## Responses and Errors

    Standard HTTP status codes are used (`2xx`, `4xx`, `5xx`). All error responses are wrapped in an `error` object containing `name`, `message`, `code`, and `status`. Validation errors additionally include field-level details in `error.validation_errors`. See the Error handling section below for the full format and status table. ## Pagination

    List endpoints use `page` (1-based) and `size` (1-100, default 20). Paginated responses follow:

    `{ "": [...], "pagination": { "page_size", "page_count", "page", "total_count" } }`. ## Lists

    List routes are optimized for synchronization and operational dashboards. Most list endpoints support tenant scoping through optional `company_id` (when allowed by API key context). ## Confidential Data

    Some candidate profile values can be masked by account-level pricing/access rules. Integrations should not assume all profile fields are always fully visible. ## Customizing the Response

    Use endpoint filters (`status`, `job_id`, timestamps, taxonomy IDs, etc.) to minimize payload size and improve sync efficiency. Build incremental sync flows around timestamp filters where available. ## Supported File Formats

    File uploads use base64 payloads with metadata:

    `data`, `file_name`, `mime_type` (and optionally `size`). This format is used for candidate files, resumes, attachments, and logos.'
servers:
- url: https://api.100hires.com/v2
  description: Production API endpoint
security:
- BearerAuth: []
tags:
- name: Career Site
  description: 'Public API for career site integrations. Authenticates by company slug instead of Bearer token.


    Pass the company slug via the `X-Company-Slug` header (or `company_slug` query param).

    No user context is required — these endpoints are public.'
paths:
  /career-site/jobs:
    get:
      tags:
      - Career Site
      summary: List public jobs
      operationId: careerSiteListJobs
      security:
      - CompanySlugAuth: []
      parameters:
      - name: company_slug
        in: query
        required: false
        schema:
          type: string
        description: Company slug (alternative to X-Company-Slug header)
      - name: department_id
        in: query
        required: false
        description: Filter by department ID.
        schema:
          type: integer
      - name: employment_type_id
        in: query
        required: false
        description: Filter by employment type ID (e.g. Full-time, Part-time).
        schema:
          type: integer
      - name: city
        in: query
        required: false
        description: Filter by job city (exact match).
        schema:
          type: string
      - name: country
        in: query
        required: false
        description: Filter by job country (exact match).
        schema:
          type: string
      - $ref: '#/components/parameters/PageQuery'
      - $ref: '#/components/parameters/SizeQuery'
      responses:
        '200':
          description: Paginated list of public jobs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CareerSiteJobListResponse'
              example:
                jobs:
                - id: 5001
                  title: Senior Software Engineer
                  description: <p>We are looking for a senior engineer...</p>
                  department:
                    id: 1
                    name: Engineering
                  location:
                    city: San Francisco
                    country: US
                    state: CA
                  employment_type:
                    id: 1
                    name: Full-time
                  is_remote: false
                  is_hybrid: false
                  application_url: https://acme.100hires.com/jobs/5001/apply
                  form_id: 10
                  created_at: 1711036800
                pagination:
                  page_size: 25
                  page_count: 1
                  page: 1
                  total_count: 1
        '400':
          $ref: '#/components/responses/ValidationError'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '401':
          $ref: '#/components/responses/Unauthorized'
      description: Returns publicly visible jobs for the given company. Supports filtering by department, employment type, city, and country. Use to power a custom careers page.
  /career-site/jobs/{id}:
    get:
      tags:
      - Career Site
      summary: Get public job
      operationId: careerSiteGetJob
      security:
      - CompanySlugAuth: []
      parameters:
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          description: Job detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CareerSiteJobDetail'
              example:
                id: 5001
                title: Senior Software Engineer
                description: <p>We are looking for a senior engineer to join our team.</p>
                department:
                  id: 1
                  name: Engineering
                location:
                  city: San Francisco
                  country: US
                  state: CA
                employment_type:
                  id: 1
                  name: Full-time
                is_remote: false
                is_hybrid: false
                application_url: https://acme.100hires.com/jobs/5001/apply
                form_id: 10
                created_at: 1711036800
                salary_min: 120000
                salary_max: 180000
                salary_currency: USD
                salary_period: annually
                education_level:
                  id: 2
                  name: Bachelor's
                experience_level:
                  id: 3
                  name: Senior
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      description: Returns full details for a single public or unlisted job. Returns 404 for draft, archived, or internal jobs.
  /career-site/applications:
    post:
      tags:
      - Career Site
      summary: Submit job application
      operationId: careerSiteCreateApplication
      security:
      - CompanySlugAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CareerSiteApplicationRequest'
      responses:
        '200':
          description: Application created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CareerSiteApplicationResponse'
              example:
                id: 90001
                job_id: 5001
                status: pending
                created_at: 1711036800
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '400':
          $ref: '#/components/responses/ValidationError'
      description: Submits a job application on behalf of a candidate. Creates a candidate record and triggers the career-site pipeline automation (sets stage to Applied, runs source attribution).
components:
  responses:
    NotFound:
      description: Not found
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              name: Not Found
              message: Candidate not found
              code: 0
              status: 404
    Unauthorized:
      description: Unauthorized
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              name: Unauthorized
              message: Your request was made with invalid credentials.
              code: 0
              status: 401
    UnsupportedMediaType:
      description: Content-Type must be application/json
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              name: Unsupported Media Type
              message: Content-Type must be application/json
              code: 0
              status: 415
    ValidationError:
      description: Validation error
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
  schemas:
    IdName:
      type: object
      required:
      - id
      - name
      properties:
        id:
          type: integer
          description: Unique identifier.
        name:
          type: string
          description: Display name.
    CareerSiteJob:
      type: object
      required:
      - id
      - title
      - description
      - location
      - is_remote
      - is_hybrid
      - application_url
      - form_id
      - created_at
      properties:
        id:
          type: integer
          description: Job ID.
        title:
          type: string
          description: Job title.
        description:
          type: string
          description: HTML content
        department:
          nullable: true
          allOf:
          - $ref: '#/components/schemas/IdName'
        location:
          $ref: '#/components/schemas/CareerSiteLocation'
        employment_type:
          nullable: true
          allOf:
          - $ref: '#/components/schemas/IdName'
        is_remote:
          type: boolean
          description: Whether this is a remote position.
        is_hybrid:
          type: boolean
          description: Whether this is a hybrid position (office days plus remote days at the job address).
        application_url:
          type: string
          format: uri
          description: Public application form URL.
        form_id:
          type:
          - integer
          - 'null'
          description: ID of the application form this job uses — the form attached to the job, or the company default form when none is attached (the same rule the apply page at `application_url` follows). Resolve the questions server-side with `GET /forms/{id}` (private API key) and render them on your own site; submit the candidate's answers with `POST /career-site/applications`. `null` only when the company has no forms.
        created_at:
          type: integer
          format: int64
          description: Unix timestamp (seconds)
    CareerSiteLocation:
      type: object
      properties:
        city:
          type: string
          nullable: true
          description: City.
        country:
          type: string
          nullable: true
          description: Country.
        state:
          type: string
          nullable: true
          description: State or region.
    CareerSiteApplicationResponse:
      type: object
      required:
      - id
      - job_id
      - status
      - created_at
      properties:
        id:
          type: integer
          description: Created application ID.
        job_id:
          type: integer
          description: Job ID.
        status:
          type: string
          description: Application status.
          example: pending
        created_at:
          type: integer
          format: int64
          description: Unix timestamp (seconds)
    Pagination:
      type: object
      required:
      - page_size
      - page_count
      - page
      - total_count
      properties:
        page_size:
          type: integer
          description: Items per page.
        page_count:
          type: integer
          description: Total number of pages.
        page:
          type: integer
          description: Current page number.
        total_count:
          type: integer
          description: Total number of items.
    CareerSiteResumeUpload:
      type: object
      required:
      - data
      - file_name
      - mime_type
      properties:
        data:
          type: string
          description: Base64-encoded file content
        file_name:
          type: string
          description: Resume file name.
          example: resume.pdf
        mime_type:
          type: string
          description: Resume MIME type.
          example: application/pdf
    CareerSiteJobDetail:
      allOf:
      - $ref: '#/components/schemas/CareerSiteJob'
      - type: object
        properties:
          salary_min:
            type: number
            nullable: true
          salary_max:
            type: number
            nullable: true
          salary_currency:
            type: string
            nullable: true
            example: USD
          salary_period:
            type: string
            nullable: true
            example: annually
          education_level:
            nullable: true
            allOf:
            - $ref: '#/components/schemas/IdName'
          experience_level:
            nullable: true
            allOf:
            - $ref: '#/components/schemas/IdName'
    CareerSiteJobListResponse:
      type: object
      required:
      - jobs
      - pagination
      properties:
        jobs:
          type: array
          description: Array of public jobs.
          items:
            $ref: '#/components/schemas/CareerSiteJob'
        pagination:
          $ref: '#/components/schemas/Pagination'
    CareerSiteApplicationRequest:
      type: object
      required:
      - job_id
      - first_name
      - last_name
      - email
      properties:
        job_id:
          type: integer
          description: Job ID to apply to.
        first_name:
          type: string
          description: Applicant first name.
        last_name:
          type: string
          description: Applicant last name.
        email:
          type: string
          format: email
          description: Applicant email address.
        phone:
          type: string
          nullable: true
          description: Applicant phone number.
        resume:
          nullable: true
          description: Resume file upload (base64 encoded).
          allOf:
          - $ref: '#/components/schemas/CareerSiteResumeUpload'
        linkedin_url:
          type: string
          format: uri
          nullable: true
          description: Applicant LinkedIn profile URL.
        source:
          type: string
          nullable: true
          description: Application source identifier.
        answers:
          type: array
          nullable: true
          description: Array of form answer objects
          items:
            type: object
    ValidationError:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          description: Validation error details object.
          required:
          - name
          - validation_errors
          properties:
            name:
              type: string
              description: Always "Validation Error" for validation failures
              example: Validation Error
            message:
              type: string
            code:
              type: integer
              example: 0
            status:
              type: integer
              example: 400
            validation_errors:
              type: object
              description: Field-level validation errors (field name to error message)
              additionalProperties:
                type: string
              example:
                email: Email cannot be blank.
                first_name: First Name cannot be blank.
      example:
        error:
          name: Validation Error
          message: ''
          code: 0
          status: 400
          validation_errors:
            email: Email cannot be blank.
            first_name: First Name cannot be blank.
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          description: Error details object.
          required:
          - name
          - message
          - code
          - status
          properties:
            name:
              type: string
              description: Human-readable error type (e.g. "Not Found", "Bad Request", "Forbidden")
              example: Not Found
            message:
              type: string
              description: Detailed error message
              example: Candidate not found
            code:
              type: integer
              description: Application error code (0 for generic errors)
              example: 0
            status:
              type: integer
              description: HTTP status code
              example: 404
      example:
        error:
          name: Not Found
          message: Candidate not found
          code: 0
          status: 404
  headers:
    RateLimitRemaining:
      description: Remaining requests in the current rate-limit window. Returned for unapproved API keys.
      schema:
        type: integer
    RateLimitReset:
      description: Unix timestamp when the current rate-limit window resets. Returned for unapproved API keys.
      schema:
        type: integer
        format: int64
    RateLimitLimit:
      description: Request limit for the current rate-limit window. Returned for unapproved API keys.
      schema:
        type: integer
  parameters:
    SizeQuery:
      name: size
      in: query
      required: false
      description: Number of items per page (1–100). Defaults to 20.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    IdPath:
      name: id
      in: path
      required: true
      description: Resource ID (numeric).
      schema:
        type: integer
    PageQuery:
      name: page
      in: query
      required: false
      description: Page number (1-based). Defaults to 1.
      schema:
        type: integer
        minimum: 1
        default: 1
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: APIKey
      description: 'Provide API token in header: `Authorization: Bearer <token>`. Each key is scoped to a specific user + company pair.'
    CompanySlugAuth:
      type: apiKey
      in: header
      name: X-Company-Slug
      description: 'Company slug for career site public endpoints. Alternative: pass as query param `company_slug`.'
x-tagGroups:
- name: Recruiting Operations
  tags:
  - Candidates
  - Applications
  - Interviews
  - Jobs
  - Evaluations
  - Notes
  - Messages
  - Notification Messages
  - Forms
  - Questions
  - Email Templates
  - Nurture Campaigns
  - Template Placeholders
  - Users
  - Attachments
- name: Organization and Settings
  tags:
  - Companies
  - Taxonomy
  - Billing
  - Feedback
- name: Career Site (Public)
  tags:
  - Career Site