Litmus Hiring Invites API

Candidate invitations

OpenAPI Specification

litmus-hiring-invites-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Litmus Hiring REST Invites API
  version: v1
  description: REST API for the Litmus technical hiring platform. Litmus turns repositories, engineering tickets, and job descriptions into structured, project-based technical assessments and interview pipelines, and syncs candidate management with Ashby, Greenhouse, and Lever. This specification was GENERATED by the API Evangelist enrichment pipeline from the provider's published REST reference (https://litmushiring.com/docs/rest); Litmus does not (yet) publish a machine-readable OpenAPI document. Only operations, paths, the base URL, and the authentication scheme that are explicitly documented are represented here. Request/response bodies are modeled loosely where the docs do not publish field-level schemas — nothing is fabricated.
  contact:
    name: Litmus Support
    email: support@litmushiring.com
    url: https://litmushiring.com/docs
  x-generated-by: api-evangelist-enrichment-pipeline
  x-generated-source: https://litmushiring.com/docs/rest
servers:
- url: https://www.litmushiring.com/api/v1
  description: Production
security:
- bearerApiKey: []
tags:
- name: Invites
  description: Candidate invitations
paths:
  /invites:
    post:
      operationId: createInvite
      summary: Send a candidate invitation
      description: Send an invitation to a candidate for an assessment / role. The docs do not publish the full request body schema; callers supply the candidate and role details defined in the dashboard.
      tags:
      - Invites
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Candidate invitation payload.
      responses:
        '200':
          description: Invitation sent.
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Missing, malformed, or revoked credentials.
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      description: 'Organization-scoped API key issued in the dashboard under Settings -> API Keys, sent as `Authorization: Bearer litmus_sk_...`. A 401 indicates a missing, malformed, or revoked credential.'