Retrieve the list of customers

GET

/api/clientes/

Authorizations

apiKey

Parameters

Query Parameters

id__in

Array<integer>

nombre__icontains

string

apellido1__icontains

string

apellido2__icontains

string

email__icontains

string

dni__icontains

string

movil

string

movil__in

Array<string>

fijo

string

fijo__in

Array<string>

codigo_postal

string

codigo_postal__in

Array<string>

origen

string

origen__in

Array<string>

categoria

integer

categoria__in

Array<integer>

is_active

boolean

is_agree_rgpd

boolean

is_suscrito_newsletter

boolean

is_suscrito_encuestas

boolean

is_sms_cliente_perdido_enviado

boolean

is_email_cliente_perdido_enviado

boolean

is_agree_notificaciones_sms

boolean

is_agree_notificaciones_email

boolean

is_citas_online

boolean

is_envios_sms

boolean

is_envios_email

boolean

is_exclude_online_payments

boolean

sexo

string

Allowed values: h m

numero_ventas

integer

numero_ventas__lt

integer

numero_ventas__lte

integer

numero_ventas__gt

integer

numero_ventas__gte

integer

importe_ventas

number

importe_ventas__lt

number

importe_ventas__lte

number

importe_ventas__gt

number

importe_ventas__gte

number

importe_deudas

number

importe_deudas__lt

number

importe_deudas__lte

number

importe_deudas__gt

number

importe_deudas__gte

number

total_citas_realizadas

integer

total_citas_realizadas__lt

integer

total_citas_realizadas__lte

integer

total_citas_realizadas__gt

integer

total_citas_realizadas__gte

integer

fecha_alta

string format: date-time

fecha_alta__lt

string format: date-time

fecha_alta__lte

string format: date-time

fecha_alta__gt

string format: date-time

fecha_alta__gte

string format: date-time

fecha_firma_rgpd

string format: date

fecha_firma_rgpd__lt

string format: date

fecha_firma_rgpd__lte

string format: date

fecha_firma_rgpd__gt

string format: date

fecha_firma_rgpd__gte

string format: date

fecha_ultima_venta

string format: date

fecha_ultima_venta__lt

string format: date

fecha_ultima_venta__lte

string format: date

fecha_ultima_venta__gt

string format: date

fecha_ultima_venta__gte

string format: date

fecha_ultima_cita_realizada

string format: date

fecha_ultima_cita_realizada__lt

string format: date

fecha_ultima_cita_realizada__lte

string format: date

fecha_ultima_cita_realizada__gt

string format: date

fecha_ultima_cita_realizada__gte

string format: date

descuento_ventas

number

descuento_ventas__lt

number

descuento_ventas__lte

number

descuento_ventas__gt

number

descuento_ventas__gte

number

code

integer

code__lt

integer

code__lte

integer

code__gt

integer

code__gte

integer

limit

integer

offset

integer

Responses

200

object

count

integer

next

One of:

string
null

string format: uri

previous

One of:

string
null

string format: uri

results

Array

<= 50 items

object

Read only

integer

created

Read only

string format: date-time

updated

Read only

string format: date-time

nombre

required

string

apellido1

string

apellido2

One of:

string
null

string

dni

One of:

string
null

string

movil

One of:

string
null

string

fijo

One of:

string
null

string

email

One of:

string
null

string format: email

direccion

One of:

string
null

string

localidad

One of:

string
null

string

codigo_postal

One of:

string
null

string

fecha_nacimiento

One of:

string
null

string format: date

is_suscrito_newsletter

boolean

default: true

is_suscrito_encuestas

boolean

default: true

is_active

boolean

default: true

is_sms_cliente_perdido_enviado

Read only

boolean

is_email_cliente_perdido_enviado

Read only

boolean

is_agree_notificaciones_sms

boolean

default: true

is_agree_notificaciones_email

boolean

default: true

sexo

One of:

string
null

string

Allowed values: h m

notas

One of:

string
null

string

foto

One of:

string
null

Read only

string format: uri

origen

Read only

string

descuento_ventas

number

is_citas_online

boolean

default: true

code

By default it is an autoincremental field, but it can be overwritten as long as there is no conflict

integer

manual_code

One of:

string
null

string

is_agree_rgpd

Read only

boolean

b64_firma_rgpd

Read only

string format: base64

fecha_firma_rgpd

Read only

string format: date

file_contrato_rgpd

Read only

string format: uri

is_anonymous

Read only

boolean

is_envios_sms

This field is required if you want to send SMS to the customer

boolean

is_envios_email

This field is required if you want to send emails to the customer

boolean

prefijo_tel

One of:

string
null

string

fecha_ultima_venta

Read only

string format: date

numero_ventas

Read only

integer

importe_ventas

Read only

number

importe_deudas

Read only

number

fecha_ultima_cita_realizada

Read only

string format: date

total_citas_realizadas

Read only

integer

fecha_alta

Read only

string format: date-time

provincia

One of:

object
integer

Read only

object

Province identifier

integer

value

Province identifier

integer

text

Province name

string

created_by

One of:

object
integer

Read only

object

value

User identifier

integer

text

User name

string

color

string format: hex

username

string format: email

foto_url_absolute_path

string format: uri

categoria

One of:

object
integer

Read only

object

value

integer

text

string

nombre

string

integer

orden

One of:

integer
null

integer

is_active

boolean

como_nos_conocio

One of:

object
integer

Read only

object

value

integer

text

string

informacion_clinica

One of:

string
null

string

401

Access key was not provided in the X-Koibox-Key header

Headers

WWW-Authenticate

string

default: X-Koibox-Key

Indicates the required header for authentication

403

A valid access key was not provided