Listar clientes

Devuelve clientes de la organización. Permite buscar por nombre, CUIT o email.

GET /api/v1/customers

La Pyme SDK

TypeScript

import { Lapyme } from "lapyme";

const lapyme = new Lapyme({
  bearerAuth: process.env["LAPYME_API_KEY"] ?? "",
});

const customers = await lapyme.customers.get({
  limit: 20,
  query: "Acme",
});

200

{
  "request_id": "<string>",
  "data": [
    {
      "object": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "company_name": "<string>",
      "description": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "address": "<string>",
      "apartment": "<string>",
      "city": "<string>",
      "tax_id": "<string>",
      "tax_id_type": "<string>",
      "tax_category": "<string>",
      "contact_type": "<string>",
      "default_price_list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_term_id": "<string>",
      "province_id": "<string>",
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>",
  "url": "<string>"
}

Authorizations

Authorization · string · header · required

Incluí tu API key en el header Authorization con el prefijo Bearer.

Query Parameters

cursor · string

Valor de next_cursor recibido en la respuesta anterior

limit · integer · default: 50

Cantidad máxima de resultados por respuesta

Required range: 1 <= x <= 100

query · string

Texto de búsqueda por nombre, CUIT o email

search · string

Alias de query

is_active · boolean

Filtra por estado activo

status · enum<string>[]

Estado lógico del cliente. Puede repetirse o enviarse separado por comas.

Available options: active, inactive

Response

200

application/json

Clientes obtenidos exitosamente

request_id · string · required

data · object[] · required

Show child attributes

has_more · boolean · required

next_cursor · string | null · required

object · enum<string> · required

List-envelope discriminator.

Available options: list

url · string · required

Requested list path.