> ## 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.

# Obtén los usuarios

> Obtiene una lista de usuarios según los filtros indicados.



## OpenAPI

````yaml es/api-reference/api-swagger-dev-documentation.json GET /api/partner/users
openapi: 3.0.0
info:
  title: API de identifAI
  version: 1.0.0
  description: >-
    API para integrar las funcionalidades de clasificación de imágenes y vídeos
    de identifAI.<br><details><summary>**Cómo obtener tu API key**</summary>Para
    obtener tu API key, sigue estos sencillos pasos:   <ol><li><p>**Crea un
    perfil de usuario y accede a la plataforma**</p>Si todavía no tienes una
    cuenta, visita nuestra plataforma y crea un perfil de usuario. Después de
    completar el registro y verificar tu correo electrónico, accede con tus
    credenciales.</li><li><p>**Abre el menú de usuario**</p>Después de acceder,
    haz clic en tu nombre o en el icono de usuario en la esquina superior
    derecha de la pantalla.</li><li><p>**Selecciona la opción API key**</p>En el
    menú desplegable que aparece, selecciona la opción "Api-Key". Desde allí
    puedes ver o generar tu API key.</li></ol>¡Ya puedes usar tu API key con
    nuestra API!</details><details><summary>**Cómo usar la API**</summary>Para
    usar la API, realiza primero una solicitud **POST** para iniciar la
    clasificación. Después usa el ***identificador*** devuelto por la solicitud
    **POST** para obtener los resultados.

    <details>

    <summary>**1. Clasificación de imágenes**</summary>
      * Para clasificar una imagen, realiza una solicitud **POST** a `/api/classification` con los parámetros obligatorios (para más detalles sobre los parámetros, consulta la sección *"Clasificación"* más abajo).
      * En la respuesta recibirás el ***identificador*** de la imagen clasificada.
      * Usa el ***identificador*** recibido para obtener los resultados de la clasificación con una solicitud **GET** a `/api/classification/{identifier}` (para más detalles sobre cómo estructurar la solicitud, consulta la sección *"Clasificación"* más abajo).
      * La respuesta contiene los resultados de la clasificación de la imagen en formato JSON.<br>En la respuesta encontrarás un array ***results***, con los resultados de la clasificación de cada modelo usado, y un array ***verdicts***, con los resultados de cada heurística aplicada.<br>Si la clasificación aún no se ha completado, sigue enviando la solicitud **GET** hasta que el resultado esté disponible.</details><details><summary>**2. Clasificación de vídeos**</summary>
        * Para clasificar un vídeo, realiza una solicitud **POST** a `/api/classification_video` con los parámetros obligatorios (para más detalles sobre los parámetros, consulta la sección *"Clasificación"* más abajo).
        * En la respuesta recibirás el ***identificador*** del vídeo clasificado.
        * Usa el ***identificador*** recibido para obtener los resultados de la clasificación con una solicitud **GET** a `/api/classification_video/{identifier}` (para más detalles sobre cómo estructurar la solicitud, consulta la sección *"Clasificación"* más abajo).
        * La respuesta contiene los resultados de la clasificación del vídeo en formato JSON. Para la clasificación, el vídeo se divide en *frames*.<br> En la respuesta encontrarás un array ***results***, con el resultado de la clasificación de cada modelo aplicado a cada frame analizado, y un array ***verdicts***, con los resultados de cada heurística usada.<br> Si la clasificación no se ha completado, sigue enviando la solicitud **GET** hasta que se devuelvan los resultados finales.</details><details><summary>**3. Todas las clasificaciones**</summary>El endpoint `/api/classifications` devuelve todas las clasificaciones de imágenes realizadas por un usuario, con los resultados de todas las solicitudes de clasificación de imágenes anteriores.</details><details><summary>**4. Gestión de usuarios**</summary>  El endpoint **POST** `/api/user` permite crear un usuario, mientras que el endpoint **DELETE** `/api/user` sirve para eliminar un usuario (para la estructura de las solicitudes, consulta la sección de usuarios más abajo).</details></details>
servers:
  - url: https://backend.identifai.net
security: []
tags:
  - name: Classification
    description: Rutas de clasificación
  - name: Infrastructure
    description: Rutas de infraestructura
  - name: User
    description: Acciones del usuario
  - name: Partner
    description: Acciones de los partners
paths:
  /api/partner/users:
    get:
      tags:
        - Partner
      summary: Obtén los usuarios
      description: Obtiene una lista de usuarios según los filtros indicados.
      parameters:
        - name: search
          in: query
          schema:
            type: string
          description: >-
            Filtra los usuarios por nombre o correo electrónico (coincidencia
            parcial).
        - name: pricing_id
          in: query
          schema:
            type: integer
          description: Filtra los usuarios por el ID de su plan de precios.
        - name: order
          in: query
          schema:
            type: string
            default: id
          description: El campo por el que se ordenan los resultados.
        - name: direction
          in: query
          schema:
            type: string
            enum:
              - desc
              - asc
          description: >-
            Dirección de la ordenación: `asc` para ascendente, `desc` para
            descendente.
        - name: per_page
          in: query
          schema:
            type: integer
          description: >-
            Número de resultados por página. Si se omite, se devuelven todos los
            resultados.
      responses:
        '200':
          description: >-
            Lista paginada de los usuarios que cumplen los criterios de
            búsqueda.
          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: >-
            Parámetros de consulta no válidos, plan de precios ausente o no
            accesible, no quedan plazas disponibles en el plan de precios del
            partner o contraseña incorrecta.
        '403':
          description: >-
            El partner no está autorizado a acceder al usuario o el usuario no
            está autorizado a usar la API.
        '429':
          description: Demasiadas solicitudes.
          content:
            application/json:
              example:
                error: Too Many Attempts.
      security:
        - ApiKeyAuth: []
components:
  schemas:
    UserList:
      type: object
      properties:
        current_page:
          type: integer
          description: Número de la página actual
        data:
          type: array
          description: Lista de los usuarios de la página actual
          items:
            $ref: '#/components/schemas/User'
        from:
          type: integer
          description: Índice del primer usuario de la página actual
        last_page:
          type: integer
          description: Número total de páginas
        next_page_url:
          type: string
          format: uri
          description: URL de la página siguiente (si existe)
        per_page:
          type: integer
          description: Número de usuarios por página
        to:
          type: integer
          description: Índice del último usuario de la página actual
        total:
          type: integer
          description: Número total de usuarios
    User:
      type: object
      properties:
        id:
          type: integer
          description: Identificador único del usuario.
        name:
          type: string
          description: Nombre completo del usuario.
        email:
          type: string
          format: email
          description: Dirección de correo electrónico del usuario.
        email_verified_at:
          type: string
          format: date-time
          description: Timestamp de la verificación del correo electrónico.
        address:
          type: string
          nullable: true
          description: Dirección del usuario.
        zip:
          type: string
          nullable: true
          description: Código postal del usuario.
        city:
          type: string
          nullable: true
          description: Ciudad del usuario.
        country:
          type: string
          nullable: true
          description: País del usuario.
        phone:
          type: string
          nullable: true
          description: Número de teléfono del usuario.
        contact:
          type: string
          nullable: true
          description: Información de contacto alternativa.
        vat:
          type: string
          nullable: true
          description: Número de IVA del usuario, si procede.
        created_at:
          type: string
          format: date-time
          description: Timestamp de creación del usuario.
        updated_at:
          type: string
          format: date-time
          description: Timestamp de la última actualización del usuario.
        balance:
          type: number
          description: El saldo de créditos del usuario.
        heuristic:
          type: string
          description: La heurística configurada para el usuario.
        readonly:
          type: boolean
          description: El usuario solo puede ver los resultados de las clasificaciones.
        pricing:
          $ref: '#/components/schemas/Pricing'
          description: Plan de precios del usuario.
        partner:
          $ref: '#/components/schemas/User'
          description: Partner del usuario.
    Pricing:
      type: object
      properties:
        id:
          type: integer
          description: El ID del plan de precios.
        name:
          type: string
          description: Nombre del plan de precios.
        sku:
          type: string
          description: Código SKU asociado al plan de precios.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: Tu API key.

````

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