> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.client-p.pylote.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Query the Pylote referential (accepted filter values)

> Public endpoint. Returns the accepted values for profile fields and for
the `POST /partners/search` filters.

Fields: `Skills`, `Regions`, `Seniority`, `Professions`, `Languages`,
`RemoteWork`, `MissionDuration`, `DaysPerWeek`.

Which item field to use in search filters: `name` for `skills` and
`workAreas`, `slug` for `seniority`.




## OpenAPI

````yaml /openapi.yaml post /referential
openapi: 3.1.0
info:
  title: Pylote Client API
  version: 1.0.4
  description: >
    API de distribution des profils freelances Pylote.


    Permet aux clients (recruteurs, integrateurs, partenaires) de recuperer

    les freelances depuis la base Pylote, gerer les whitelist recruteurs

    et tracker les consultations de profils.


    Les profils sont retournes au format [JSON
    Resume](https://jsonresume.org/schema/)

    enrichi avec les metadonnees Pylote (disponibilite, TJM, mobilites,
    competences).


    ## Engagements clients


    En utilisant cette API, vous vous engagez a :

    1. **Tracker les consultations** de profils via `POST
    /partners/{slug}/events` (contractuel)

    2. **Supprimer les profils** dont le `status` est `deleted` de votre base

    3. **Ne jamais exposer** les emails personnels des freelances (utiliser les
    emails proxy Pylote)


    ## Protection des donnees


    Les donnees sont transformees avant distribution :

    - Les emails personnels sont remplaces par des **emails proxy**
    (`@freelance.pylote.io`)

    - Le champ `personalEmail` est un **hash SHA-256** (pour dedoublonnage,
    jamais l'email en clair)

    - Les URLs LinkedIn et CV passent par `hive.pylote.io` (tracking watermarke)

    - Les identifiants (`meta.id`) sont **chiffres** (AES-256-CBC) et opaques
  contact:
    name: Pylote
    url: https://pylote.io
    email: contact@pylote.io
servers:
  - url: https://client-p.pylote.io
    description: Production
  - url: https://client-pp.pylote.io
    description: Preprod
security:
  - apiKey: []
tags:
  - name: Freelances
    description: >
      Endpoints principaux pour recuperer les profils freelances.

      Les profils sont au format JSON Resume enrichi avec les metadonnees
      Pylote.
  - name: Partners
    description: >
      Endpoints pour les partenaires de distribution (ex: Agrega).

      Gestion de la whitelist recruteurs et **tracking obligatoire** des
      consultations de profils.
  - name: Integration
    description: |
      Endpoints pour les integrateurs (ex: BoondManager).
      Gestion des sous-clients et de leurs whitelist recruteurs.
  - name: Sandbox
    description: >
      Endpoints de test avec donnees anonymisees. Aucune cle API requise.

      Utilisez la sandbox pour valider votre integration avant de passer en
      production.
  - name: Admin
    description: >-
      Endpoints d'administration (cache, debug). Requiert un flag admin sur la
      cle API.
  - name: Health
    description: Health check de l'API et de ses dependances externes
paths:
  /referential:
    post:
      tags:
        - Referential
      summary: Query the Pylote referential (accepted filter values)
      description: |
        Public endpoint. Returns the accepted values for profile fields and for
        the `POST /partners/search` filters.

        Fields: `Skills`, `Regions`, `Seniority`, `Professions`, `Languages`,
        `RemoteWork`, `MissionDuration`, `DaysPerWeek`.

        Which item field to use in search filters: `name` for `skills` and
        `workAreas`, `slug` for `seniority`.
      operationId: queryReferential
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - action
                - field
              properties:
                action:
                  type: string
                  enum:
                    - list:all
                  example: list:all
                field:
                  type: string
                  example: Seniority
      responses:
        '200':
          description: List of referential items
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      example: Senior 6-10 ans
                    slug:
                      type: string
                      example: senior_6-10_ans
      security: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >
        Cle API fournie par Pylote. Inclure dans le header `x-api-key` de chaque
        requete.


        Exemple : `x-api-key: votre-cle-api`

````