Saltar al contenido

Se aplican las mismas reglas de visibilidad que en el panel: los servicios que vencieron por completo están ocultos de forma predeterminada. Con state puedes filtrar por el estado que se ve en el panel.

Un parámetro desconocido o un valor no válido devuelve 400 invalid_request; details.field indica de qué parámetro se trata.

El endpoint de lista no incluye estadísticas. Se mantuvo ligero a propósito, porque habría que consultar el backend por cada servicio; obtén los datos de uso del endpoint Detalles del servicio.

Autorización

Authorizationstringobligatorio

Se envía como Bearer <token>. Este endpoint requiere el permiso orders:read (Información de servicios); un token sin él recibe 403.

Parámetros de consulta

typeenum<string>

Filtra por tipo de servicio.

statusstring

Filtra por el estado en bruto.

stateenum<string>

Filtra por el estado que se ve en el panel. Si se indica expired, también se listan los servicios que vencieron por completo. Los valores están en la página Estados del servicio.

limitintegerpredeterminado: 25

Registros por página: 1-100. Un valor 0, negativo o no entero devuelve 400; un valor mayor que 100 se reduce a 100 (meta.limit muestra el valor aplicado).

offsetintegerpredeterminado: 0

El número de registros que se omiten.

include_expiredboolean

true también lista los servicios vencidos por completo y los cancelados. Se activa automáticamente si se indica status=expired o cancelled.

Respuesta

200
application/json
dataobject[]
metaobject