Consultar todos los vendedores

Endpoint para consultar vendedores

Endpoint que permite consultar todos los vendedores asociados a la empresa

get/sellers

Request

  • Base URL
    https://api.alegra.com/api/v1
  • URL
    https://api.alegra.com/api/v1/sellers
  • Auth
    HTTP basic

Query parameters

startinteger

Desde cual vendedor se quiere consultar. Por ejemplo para consultar desde el vendedor 20, se envía start=20

limitinteger

Cantidad de vendedores a partir del inicio que se desea retornar. Por defecto retorna 30 vendedores

statusstring[]

Filtrar por estado del vendedor

Response

Operación exitosa

idstring

Identificador único que representa un vendedor específico. La aplicación lo asigna automáticamente.

namestring required

Nombre del vendedor.

identificationstring

Número de identificación del vendedor.

observationsstring

Observaciones del vendedor.

status'active' | 'inactive'

Estado del vendedor. Las opciones posibles son active => El vendedor se encuentra activo. inactive => El vendedor se encuentra inactivo.

Example response

[
  {
    "name": "Pedro Perez",
    "identification": "1.000.123",
    "observations": "Vendedor tienda principal"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.