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

# Recupera gli utenti

> Recupera un elenco di utenti in base ai filtri indicati.



## OpenAPI

````yaml it/api-reference/api-swagger-dev-documentation.json GET /api/partner/users
openapi: 3.0.0
info:
  title: API di identifAI
  version: 1.0.0
  description: >-
    API per integrare le funzionalità di classificazione di immagini e video di
    identifAI.<br><details><summary>**Come ottenere la tua API
    key**</summary>Per ottenere la tua API key, segui questi semplici
    passaggi:   <ol><li><p>**Crea un profilo utente e accedi alla
    piattaforma**</p>Se non hai ancora un account, visita la nostra piattaforma
    e crea un profilo utente. Dopo aver completato la registrazione e verificato
    la tua e-mail, accedi con le tue credenziali.</li><li><p>**Apri il menu
    utente**</p>Dopo l'accesso, fai clic sul tuo nome o sull'icona utente in
    alto a destra nello schermo.</li><li><p>**Seleziona la voce API key**</p>Nel
    menu a tendina che compare, seleziona la voce "Api-Key". Da lì puoi
    visualizzare o generare la tua API key.</li></ol>Ora sei pronto per usare la
    tua API key con la nostra API!</details><details><summary>**Come usare
    l'API**</summary>Per usare l'API, effettua prima una richiesta **POST** per
    avviare la classificazione. Poi usa l'***identificativo*** restituito dalla
    richiesta **POST** per recuperare i risultati.

    <details>

    <summary>**1. Classificazione delle immagini**</summary>
      * Per classificare un'immagine, effettua una richiesta **POST** a `/api/classification` con i parametri richiesti (per i dettagli sui parametri consulta la sezione *"Classificazione"* qui sotto).
      * Nella risposta riceverai l'***identificativo*** dell'immagine classificata.
      * Usa l'***identificativo*** ricevuto per recuperare i risultati della classificazione con una richiesta **GET** a `/api/classification/{identifier}` (per i dettagli su come strutturare la richiesta consulta la sezione *"Classificazione"* qui sotto).
      * La risposta contiene i risultati della classificazione dell'immagine in formato JSON.<br>Nella risposta trovi un array ***results***, con i risultati della classificazione di ogni modello usato, e un array ***verdicts***, con i risultati di ogni euristica applicata.<br>Se la classificazione non è ancora completa, continua a inviare la richiesta **GET** finché il risultato non è disponibile.</details><details><summary>**2. Classificazione dei video**</summary>
        * Per classificare un video, effettua una richiesta **POST** a `/api/classification_video` con i parametri richiesti (per i dettagli sui parametri consulta la sezione *"Classificazione"* qui sotto).
        * Nella risposta riceverai l'***identificativo*** del video classificato.
        * Usa l'***identificativo*** ricevuto per recuperare i risultati della classificazione con una richiesta **GET** a `/api/classification_video/{identifier}` (per i dettagli su come strutturare la richiesta consulta la sezione *"Classificazione"* qui sotto).
        * La risposta contiene i risultati della classificazione del video in formato JSON. Per la classificazione, il video viene suddiviso in *frame*.<br> Nella risposta trovi un array ***results***, con l'esito della classificazione di ogni modello applicato a ogni frame analizzato, e un array ***verdicts***, con i risultati di ogni euristica usata.<br> Se la classificazione non è completa, continua a inviare la richiesta **GET** finché non vengono restituiti i risultati finali.</details><details><summary>**3. Tutte le classificazioni**</summary>L'endpoint `/api/classifications` restituisce tutte le classificazioni di immagini effettuate da un utente, con i risultati di tutte le richieste di classificazione di immagini passate.</details><details><summary>**4. Gestione degli utenti**</summary>  L'endpoint **POST** `/api/user` permette di creare un utente, mentre l'endpoint **DELETE** `/api/user` serve a eliminare un utente (per la struttura delle richieste consulta la sezione sugli utenti qui sotto).</details></details>
servers:
  - url: https://backend.identifai.net
security: []
tags:
  - name: Classification
    description: Route di classificazione
  - name: Infrastructure
    description: Route dell'infrastruttura
  - name: User
    description: Azioni dell'utente
  - name: Partner
    description: Azioni dei partner
paths:
  /api/partner/users:
    get:
      tags:
        - Partner
      summary: Recupera gli utenti
      description: Recupera un elenco di utenti in base ai filtri indicati.
      parameters:
        - name: search
          in: query
          schema:
            type: string
          description: Filtra gli utenti per nome o e-mail (corrispondenza parziale).
        - name: pricing_id
          in: query
          schema:
            type: integer
          description: Filtra gli utenti per ID del piano tariffario.
        - name: order
          in: query
          schema:
            type: string
            default: id
          description: Il campo in base a cui ordinare i risultati.
        - name: direction
          in: query
          schema:
            type: string
            enum:
              - desc
              - asc
          description: >-
            Direzione dell'ordinamento: `asc` per crescente, `desc` per
            decrescente.
        - name: per_page
          in: query
          schema:
            type: integer
          description: >-
            Numero di risultati per pagina. Se omesso, vengono restituiti tutti
            i risultati.
      responses:
        '200':
          description: >-
            Elenco paginato degli utenti che corrispondono ai criteri di
            ricerca.
          content:
            application/json:
              example:
                current_page: 1
                data:
                  - id: 222
                    name: User
                    email: User@mail.com
                    email_verified_at: '2025-03-03T13:28:03.000000Z'
                    address: null
                    zip: null
                    city: null
                    country: null
                    phone: null
                    contact: null
                    vat: null
                    created_at: '2025-03-03T13:28:03.000000Z'
                    updated_at: '2025-03-12T09:32:43.000000Z'
                    balance: 0
                    heuristic: AverageExcludeObsolete
                    readonly: null
                    pricing:
                      id: 1
                      name: TestB
                      sku: testB
                    partner:
                      id: 221
                      name: Partner
                      email: Partner@gmail.com
                      email_verified_at: '2025-03-03T11:22:49.000000Z'
                      address: null
                      zip: null
                      city: null
                      country: null
                      phone: null
                      contact: null
                      vat: null
                      created_at: '2025-03-03T11:22:49.000000Z'
                      updated_at: '2025-03-03T13:27:06.000000Z'
                      balance: 0
                      heuristic: Average
                      readonly: false
                      pricing:
                        id: 2
                        name: TestAC
                        sku: testAC
                      partner: null
                from: 1
                last_page: 1
                next_page_url: null
                per_page: 100
                to: 1
                total: 1
              schema:
                $ref: '#/components/schemas/UserList'
        '400':
          description: >-
            Parametri della query non validi, piano tariffario mancante o non
            accessibile, posti esauriti per il piano tariffario del partner o
            password errata.
        '403':
          description: >-
            Il partner non è autorizzato ad accedere all'utente o l'utente non è
            autorizzato a usare l'API.
        '429':
          description: Troppe richieste.
          content:
            application/json:
              example:
                error: Too Many Attempts.
      security:
        - ApiKeyAuth: []
components:
  schemas:
    UserList:
      type: object
      properties:
        current_page:
          type: integer
          description: Numero della pagina corrente
        data:
          type: array
          description: Elenco degli utenti nella pagina corrente
          items:
            $ref: '#/components/schemas/User'
        from:
          type: integer
          description: Indice del primo utente nella pagina corrente
        last_page:
          type: integer
          description: Numero totale di pagine
        next_page_url:
          type: string
          format: uri
          description: URL della pagina successiva (se disponibile)
        per_page:
          type: integer
          description: Numero di utenti per pagina
        to:
          type: integer
          description: Indice dell'ultimo utente nella pagina corrente
        total:
          type: integer
          description: Numero totale di utenti
    User:
      type: object
      properties:
        id:
          type: integer
          description: Identificativo univoco dell'utente.
        name:
          type: string
          description: Nome completo dell'utente.
        email:
          type: string
          format: email
          description: Indirizzo e-mail dell'utente.
        email_verified_at:
          type: string
          format: date-time
          description: Timestamp della verifica dell'e-mail.
        address:
          type: string
          nullable: true
          description: Indirizzo dell'utente.
        zip:
          type: string
          nullable: true
          description: Codice postale dell'utente.
        city:
          type: string
          nullable: true
          description: Città dell'utente.
        country:
          type: string
          nullable: true
          description: Paese dell'utente.
        phone:
          type: string
          nullable: true
          description: Numero di telefono dell'utente.
        contact:
          type: string
          nullable: true
          description: Recapito alternativo.
        vat:
          type: string
          nullable: true
          description: Partita IVA dell'utente, se presente.
        created_at:
          type: string
          format: date-time
          description: Timestamp di creazione dell'utente.
        updated_at:
          type: string
          format: date-time
          description: Timestamp dell'ultimo aggiornamento dell'utente.
        balance:
          type: number
          description: Il saldo dei crediti dell'utente.
        heuristic:
          type: string
          description: L'euristica impostata per l'utente.
        readonly:
          type: boolean
          description: L'utente può solo visualizzare i risultati delle classificazioni.
        pricing:
          $ref: '#/components/schemas/Pricing'
          description: Piano tariffario dell'utente.
        partner:
          $ref: '#/components/schemas/User'
          description: Partner dell'utente.
    Pricing:
      type: object
      properties:
        id:
          type: integer
          description: L'ID del piano tariffario.
        name:
          type: string
          description: Nome del piano tariffario.
        sku:
          type: string
          description: Codice SKU associato al piano tariffario.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: La tua API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.