> ## Documentation Index
> Fetch the complete documentation index at: https://developers.0flaw.fr/llms.txt
> Use this file to discover all available pages before exploring further.

# Lister les assignations de formation

> Liste paginée des formations assignées dans l'entreprise, avec progression et score de quiz. Filtrable par statut et période.



## OpenAPI

````yaml /openapi.json get /api/v1/trainings/assignments
openapi: 3.1.0
info:
  title: API 0flaw
  version: 1.0.0
  description: >-
    API publique de 0flaw : provisionnez vos employés depuis votre SIRH/AD et
    recevez

    les événements de sécurité dans votre SIEM.


    ## Authentification

    Toutes les requêtes exigent une clé API, créée depuis votre dashboard

    (Réglages → Clés API). Transmettez-la dans l'en-tête `Authorization` :


    ```

    Authorization: Bearer 0flaw_live_xxxxxxxx

    ```


    L'en-tête `x-api-key` est également accepté. Une clé est **scopée à une
    seule

    entreprise** : elle ne peut jamais lire ni modifier les données d'une autre.


    ## Limites de débit

    600 requêtes par tranche de 15 minutes et par clé. Les en-têtes
    `RateLimit-*`

    accompagnent chaque réponse ; un dépassement renvoie `429`.


    ## Gestion des erreurs

    Fiez-vous au champ `code` (stable) et non au `message` (susceptible
    d'évoluer).
  contact:
    name: Support 0flaw
    url: https://app.0flaw.fr
servers:
  - url: https://api.0flaw.fr
    description: Production
security:
  - apiKey: []
tags:
  - name: Général
    description: Vérification d'accès et introspection de la clé
  - name: Employés
    description: 'Provisioning : création, mise à jour, désactivation, invitations'
  - name: Résultats
    description: Campagnes de phishing et leurs résultats (scope read:results)
  - name: Radar
    description: Risk scores par axe (scope read:scores)
  - name: Formations
    description: Statut des formations des employés (scope read:trainings)
paths:
  /api/v1/trainings/assignments:
    get:
      tags:
        - Formations
      summary: Lister les assignations de formation
      description: >-
        Liste paginée des formations assignées dans l'entreprise, avec
        progression et score de quiz. Filtrable par statut et période.
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Numéro de page
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Éléments par page (max 100)
        - name: from
          in: query
          schema:
            type: string
            format: date
          description: 'Début de période (défaut : 30 jours en arrière)'
        - name: to
          in: query
          schema:
            type: string
            format: date
          description: 'Fin de période (défaut : aujourd''hui)'
        - name: status
          in: query
          schema:
            type: string
            enum:
              - assigned
              - in_progress
              - completed
          description: Filtrer sur un statut
      responses:
        '200':
          description: Assignations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TrainingAssignment'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
                required:
                  - data
                  - pagination
        '401':
          description: Clé API absente ou invalide
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                message: Clé API invalide ou révoquée
                code: API_KEY_INVALID
        '403':
          description: La clé ne porte pas le scope requis
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                message: 'Scope requis : write:employees'
                code: INSUFFICIENT_SCOPE
        '429':
          description: Quota de requêtes dépassé pour cette clé
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                message: Trop de requêtes, réessayez plus tard.
                code: RATE_LIMIT_EXCEEDED
      security:
        - apiKey:
            - read:trainings
components:
  schemas:
    TrainingAssignment:
      type: object
      properties:
        id:
          type: string
        formation:
          type: object
          properties:
            id:
              type: string
            nom:
              type: string
            tag:
              type:
                - string
                - 'null'
        employe:
          type: object
          properties:
            id:
              type: string
            nom:
              type: string
            prenom:
              type: string
            email:
              type: string
        status:
          type: string
          enum:
            - assigned
            - in_progress
            - completed
        assigned_at:
          type:
            - string
            - 'null'
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
        progression:
          type: integer
          description: Pourcentage de vidéos terminées
        score_quiz_moyen:
          type:
            - integer
            - 'null'
    Pagination:
      type: object
      properties:
        page:
          type: integer
        limit:
          type: integer
        total:
          type: integer
        total_pages:
          type: integer
        has_more:
          type: boolean
      required:
        - page
        - limit
        - total
        - total_pages
        - has_more
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: Message lisible par un humain
        code:
          type: string
          description: Code stable, à utiliser pour la logique client
      required:
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Clé API créée depuis le dashboard (Réglages → Clés API). L'en-tête
        `x-api-key: <clé>` est accepté en alternative à `Authorization: Bearer
        <clé>`.

````