---
agentTools:
  projectIndex: https://virtualpos.readme.io/llms.txt
---

# Listar objetos Client

Permite recuperar la información de varios clientes mediante parámetros

El orden por defecto es **created** descendente (clientes más recientes primero).

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "VirtualPOS",
    "version": "3.0"
  },
  "servers": [
    {
      "url": "https://api.virtualpos.cl"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/v3/clients": {
      "get": {
        "summary": "Listar objetos Client",
        "description": "Permite recuperar la información de varios clientes mediante parámetros",
        "operationId": "listar-objetos-client",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "API KEY del comercio",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Signature",
            "in": "header",
            "description": "Firma del mensaje",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Página a recuperar.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Cantidad de registros por página.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 100
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filtra por estado del cliente: ACTIVO, BLOQUEADO.",
            "schema": {
              "type": "string",
              "enum": [
                "'ACTIVO'",
                "'BLOQUEADO'"
              ],
              "default": "all"
            }
          },
          {
            "name": "type",
            "in": "query",
            "description": "Filtra por tipo de cliente: PERSONA, EMPRESA.",
            "schema": {
              "type": "string",
              "enum": [
                "'PERSONA'",
                "'EMPRESA'"
              ]
            }
          },
          {
            "name": "social_id",
            "in": "query",
            "description": "Filtra por documento.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "email",
            "in": "query",
            "description": "Fitra por email.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "created_from",
            "in": "query",
            "description": "Filtra clientes creados desde esta fecha (inclusive).",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "created_to",
            "in": "query",
            "description": "Filtra clientes creados hasta esta fecha (inclusive).",
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"clients\": [\n    {\n      \"uuid\": \"cli_00183af742e91dc3\",\n      \"status\": \"ACTIVO\",\n      \"type\": \"PERSONA\",\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"email\": \"user@example.com\",\n      \"phone_number\": \"56961934502\",\n      \"social_id_type\": \"RUT\",\n      \"social_id\": \"12345678-9\",\n      \"birth_date\": \"1990-01-01\",\n      \"gender_id\": \"Masculino\",\n      \"created\": \"2025-01-08 11:20:31\",\n      \"updated\": \"2025-01-10 09:15:00\"\n    },\n    {\n      \"uuid\": \"cli_00183af742e91dc4\",\n      \"status\": \"BLOQUEADO\",\n      \"type\": \"EMPRESA\",\n      \"first_name\": \"Acme S.A.\",\n      \"last_name\": \"\",\n      \"email\": \"user2@example.com\",\n      \"phone_number\": \"56223456789\",\n      \"social_id_type\": \"RUT\",\n      \"social_id\": \"76432154-2\",\n      \"birth_date\": “”,\n      \"gender_id\": “”,\n      \"created\": \"2025-01-01 09:00:00\",\n      \"updated\": \"2025-01-05 10:00:00\"\n    }\n  ],\n  \"page\": 1,\n  \"limit\": 100,\n  \"total\": 2\n}\n"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"NOK\",\n    \"code\": 400,\n    \"error\": {\n        \"error_code\": \"E-###\",\n        \"message\": \"detalle del error\",\n        \"doc_url\": \"https://virtualpos.readme.io/reference/objeto-error\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "NOK"
                    },
                    "code": {
                      "type": "integer",
                      "example": 400,
                      "default": 0
                    },
                    "error": {
                      "type": "object",
                      "properties": {
                        "error_code": {
                          "type": "string",
                          "example": "E-###"
                        },
                        "message": {
                          "type": "string",
                          "example": "detalle del error"
                        },
                        "doc_url": {
                          "type": "string",
                          "example": "https://virtualpos.readme.io/reference/objeto-error"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "63d857da7710f60012144a5b:6914d9d4b1799a276dd0de9a"
}
```