Saltearse al contenido
Koibox Documentación para desarrolladores de Koibox

Recuperar el listado de citas

GET
/api/agenda/

Authorizations

Parameters

Query Parameters

id__in
Array<integer>
fecha__gte
string format: date-time
fecha__lte
string format: date-time
fecha__gt
string format: date-time
fecha__lt
string format: date-time
user__id
integer
user__id__in
Array<integer>
estado__id
integer
estado__id__in
Array<integer>
cliente__id
integer
cliente__id__in
Array<integer>
is_cliente_en_centro
boolean
limit
integer
offset
integer

Responses

200

Listado de las citas solicitadas

object
count
integer
next
One of:
string format: uri
previous
One of:
string format: uri
results
Array
<= 50 items
object
id

Solo lectura

integer
notas
string
duracion
string format: time
created

Solo lectura

string format: date-time
updated

Solo lectura

string format: date-time
titulo
required
string
observaciones
string
historico

Solo lectura

string format: html
is_empleado_aleatorio
boolean
fecha
required

Fecha de la cita, se espera en zona horaria del centro

string format: date
hora_inicio
required
string format: time
hora_fin
required
string format: time
is_notificada_por_sms

Solo lectura

boolean
is_notificada_por_email

Solo lectura

boolean
is_notificada_por_push

Solo lectura

boolean
origen

Solo lectura

string
Allowed values: c p w f i a t in pa pc g s api ig
precio

Solo lectura

number
precio_sin_descuento

Solo lectura

number
descuento

Solo lectura

number
is_cliente_en_centro
boolean
is_notificada_por_whatsapp

Solo lectura

boolean
user
required
One of:

Solo lectura

object
value

Identificador del usuario

integer
text

Nombre del usuario

string
color
string format: hex
username
string format: email
foto_url_absolute_path
string format: uri
created_by

Solo lectura

object
value

Identificador del usuario

integer
text

Nombre del usuario

string
color
string format: hex
username
string format: email
foto_url_absolute_path
string format: uri
cliente
One of:

Solo lectura

object
text

Nombre del cliente

string
value

Identificador del cliente

integer
email
string format: email
movil

Número de móvil del cliente

string format: tel
notas
string
is_anonymous
boolean
foto_url_absolute_path
string format: uri
localidad
string
importe_ventas
number
importe_deudas
number
code
integer
manual_code
string
fijo
string
dni
string
prefijo_tel
integer
estado
One of:

Solo lectura

object
id

Identificador del estado

integer
value
integer
nombre
string
text
string
parent

Cita padre a la actual, solo lectura

integer
servicios
Array<object>
object
id

Solo lectura

integer
created

Solo lectura

string format: date-time
updated

Solo lectura

string format: date-time
referencia
required
string
nombre
required
string
detalle
string
precio
string format: double
is_tarifas
boolean
precio_tarifa1
string format: double
precio_tarifa2
string format: double
precio_tarifa3
string format: double
precio_tarifa4
string format: double
duracion
required
string format: time
categoria
One of:

Solo lectura

object
value
integer
text
string
nombre
string
id
integer
orden
One of:
integer
is_active
boolean
is_active
boolean
users
required
One of:

Solo lectura

Array<object>
object
value

Identificador del usuario

integer
text

Nombre del usuario

string
color
string format: hex
username
string format: email
foto_url_absolute_path
string format: uri
is_disponible_online
boolean
descuento_online
integer
secure_payment_amount
double
productos_escandallo
One of:

Solo lectura

Array<object>
object
id

Solo lectura

integer
categoria
required
One of:

Solo lectura

object
value
integer
text
string
nombre
string
id
integer
orden
One of:
integer
is_active
boolean
proveedor
One of:

Solo lectura

object
servicios_escandallo
Array<object> recursive
stock
object
existencias
integer
stock_minimo
integer
created
string format: date-time
updated
string format: date-time
barcode
string
<= 30 characters
referencia
string
<= 20 characters
nombre
required
string
<= 100 characters
detalle
string
precio
number
precio_online
number
precio_coste
number
pedido_minimo
integer
is_active
boolean
default: true
is_uso_interno
boolean
is_disponible_ecommerce
boolean
default: true
imagenes
Array<object>
object
name

Nombre del archivo

string
size

Tamaño del archivo (en bytes)

integer
type

Tipo MIME del archivo

string
opts
object
principal

Indica si es la imagen principal del producto

boolean
impuesto
integer
recursos

Solo lectura

Array<object>
object
value
integer
text
string
impuesto
integer
orden
One of:
integer
tbai_vat_exemption_cause
One of:

Solo se devuelve en caso de tener TicketBAI activo

integer
created_timezone

Tiempo ajustado a la zona horaria del centro, solo lectura

string format: date-time
venta

Venta creada desde la cita, solo lectura

integer

401

No se ha proporcionado la clave de acceso en la header X-Koibox-Key

Headers

WWW-Authenticate
string
default: X-Koibox-Key

Indica la cabecera requerida para la autenticación

403

No se ha proporcionado una clave de acceso válida