Recuperar el listado de clientes
GET
/api/clientes/
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://api.koibox.cloud/api/clientes/?sexo=h"), Headers = { { "X-Koibox-Key", "<X-Koibox-Key>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.koibox.cloud/api/clientes/?sexo=h")) .header("X-Koibox-Key", "<X-Koibox-Key>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build();HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());System.out.println(response.body());OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder() .url("https://api.koibox.cloud/api/clientes/?sexo=h") .get() .addHeader("X-Koibox-Key", "<X-Koibox-Key>") .build();
Response response = client.newCall(request).execute();import axios from 'axios';
const options = { method: 'GET', url: 'https://api.koibox.cloud/api/clientes/', params: {sexo: 'h'}, headers: {'X-Koibox-Key': '<X-Koibox-Key>'}};
try { const { data } = await axios.request(options); console.log(data);} catch (error) { console.error(error);}const url = 'https://api.koibox.cloud/api/clientes/?sexo=h';const options = {method: 'GET', headers: {'X-Koibox-Key': '<X-Koibox-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.koibox.cloud/api/clientes/?sexo=h' \ --header 'X-Koibox-Key: <X-Koibox-Key>'Authorizations
Sección titulada «Authorizations»Parameters
Sección titulada «Parameters»Query Parameters
Sección titulada «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
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
Sección titulada «Responses»Media typeapplication/json
object
count
integer
results
Array
object
id
Solo lectura
integer
created
Solo lectura
string format: date-time
updated
Solo lectura
string format: date-time
nombre
required
string
apellido1
string
is_suscrito_newsletter
boolean
is_suscrito_encuestas
boolean
is_active
boolean
is_sms_cliente_perdido_enviado
Solo lectura
boolean
is_email_cliente_perdido_enviado
Solo lectura
boolean
is_agree_notificaciones_sms
boolean
is_agree_notificaciones_email
boolean
origen
Solo lectura
string
descuento_ventas
number
is_citas_online
boolean
code
Por defecto es un campo autoincremental, pero se puede sobreescribir siempre que no haya conflicto
integer
is_agree_rgpd
Solo lectura
boolean
b64_firma_rgpd
Solo lectura
string format: base64
fecha_firma_rgpd
Solo lectura
string format: date
file_contrato_rgpd
Solo lectura
string format: uri
is_anonymous
Solo lectura
boolean
is_envios_sms
Se requiere este campo si se le quieren enviar SMS al cliente
boolean
is_envios_email
Se requiere este campo si se le quieren enviar emails al cliente
boolean
fecha_ultima_venta
Solo lectura
string format: date
numero_ventas
Solo lectura
integer
importe_ventas
Solo lectura
number
importe_deudas
Solo lectura
number
fecha_ultima_cita_realizada
Solo lectura
string format: date
total_citas_realizadas
Solo lectura
integer
fecha_alta
Solo lectura
string format: date-time
provincia
created_by
categoria
puntos_disponibles
Solo lectura
integer
No se ha proporcionado la clave de acceso en la header X-Koibox-Key
Headers
Sección titulada «Headers»WWW-Authenticate
string
Indica la cabecera requerida para la autenticación
No se ha proporcionado una clave de acceso válida
