Skip to content
Koibox Koibox API Documentation

Retrieve the list of appointments

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

List of requested appointments

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

Read only

integer
notas
string
duracion
string format: time
created

Read only

string format: date-time
updated

Read only

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

Read only

string format: html
is_empleado_aleatorio
boolean
fecha
required

Appointment date, expected in the center’s timezone

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

Read only

boolean
is_notificada_por_email

Read only

boolean
is_notificada_por_push

Read only

boolean
origen

Read only

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

Read only

number
precio_sin_descuento

Read only

number
descuento

Read only

number
is_cliente_en_centro
boolean
is_notificada_por_whatsapp

Read only

boolean
user
required
One of:

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
created_by

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
cliente
One of:

Read only

object
text

Customer name

string
value

Customer identifier

integer
email
string format: email
movil

Customer mobile number

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:

Read only

object
id

Status identifier

integer
value
integer
nombre
string
text
string
parent

Parent appointment to the current one, read only

integer
servicios
Array<object>
object
id

Read only

integer
created

Read only

string format: date-time
updated

Read only

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:

Read only

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

Read only

Array<object>
object
value

User identifier

integer
text

User name

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:

Read only

Array<object>
object
id

Read only

integer
categoria
required
One of:

Read only

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

Read only

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

File name

string
size

File size (in bytes)

integer
type

File MIME type

string
opts
object
principal

Indicates if it is the main product image

boolean
impuesto
integer
recursos

Read only

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

Only returned if TicketBAI is active

integer
created_timezone

Time adjusted to the center’s timezone, read only

string format: date-time
venta

Sale created from the appointment, read only

integer

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