> ## Documentation Index
> Fetch the complete documentation index at: https://api.jobaffinity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get API index

> Returns API metadata, version information, and main entry points



## OpenAPI

````yaml /api-reference/openapi.json get /
openapi: 3.0.3
info:
  title: JobAffinity REST API
  version: '1.12'
  description: >
    JobAffinity REST API for managing jobs, candidates, applications, and
    recruitment processes.


    ## Authentication

    All endpoints require HTTP Basic Authentication.


    ## Versioning

    Current version: 1.12


    See `/restapi/changelog` for version history and changes.
  contact:
    name: JobAffinity API Support
servers:
  - url: https://jobaffinity.fr/restapi/v1
    description: REST API v1
  - url: https://jobaffinity.fr/restapi
    description: REST API root (for changelog)
security:
  - basicAuth: []
tags:
  - name: API Info
    description: API metadata and changelog
  - name: Jobs
    description: Job listings and details
  - name: Candidates
    description: Candidate information
  - name: Applications
    description: Job applications
  - name: Processes
    description: Recruitment processes and steps
  - name: Notes
    description: Candidate notes
  - name: Questionnaires
    description: Questionnaire answers
  - name: Webhooks
    description: Webhook tasks
  - name: Job Application Submission
    description: >-
      Submit candidate applications to a job posting via the apply URL provided
      in the job feed. The authentication token is embedded in the URL — no
      additional credentials are required.
paths:
  /:
    get:
      tags:
        - API Info
      summary: Get API index
      description: Returns API metadata, version information, and main entry points
      operationId: getApiIndex
      responses:
        '200':
          description: API index information
          content:
            application/json:
              schema:
                type: object
                properties:
                  _status:
                    type: string
                    enum:
                      - OK
                  _version:
                    type: string
                    example: '1.12'
                  _expiration:
                    type: string
                    nullable: true
                  _last_version_url:
                    type: string
                    format: uri
                  _self:
                    type: string
                    format: uri
                  _changelog:
                    type: object
                    properties:
                      _self:
                        type: string
                        format: uri
                  candidates:
                    type: object
                    properties:
                      _self:
                        type: string
                        format: uri
                      description:
                        type: string
                  jobs:
                    type: object
                    properties:
                      _self:
                        type: string
                        format: uri
                      description:
                        type: string
                  steps:
                    type: object
                    properties:
                      _self:
                        type: string
                        format: uri
                      description:
                        type: string
        '401':
          $ref: '#/components/responses/UnauthorizedError'
components:
  responses:
    UnauthorizedError:
      description: Authentication information is missing or invalid
      headers:
        WWW-Authenticate:
          schema:
            type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with API credentials

````