Listar Servicios

Descripción

Retorna la lista de servicios registrados en el sistema, permitiendo filtrado por ID, nombre, sucursal y estado (activo/inactivo). Los resultados pueden ser paginados mediante los parámetros take y skip.

🔑 Parámetros de Consulta (Query Params)

Parámetro	Tipo	Obligatorio	Descripción
idService	int32	No	Filtrar por el ID específico del servicio.
name	string	No	Filtrar por el nombre del servicio.
idBranch	int32	Recomendable	Filtrar por el número de la sucursal (solo aplicable para claves multilocal; ignorado en caso contrario).
showOnlyExternalIntegrationServices	boolean	No	Filtrar servicios que permiten ventas mediante integraciones externas.
showActivities	boolean	No	Mostrar actividades.
take	int32	No	Cantidad de registros a retornar (máximo 50). Por defecto: 25.
skip	int32	No	Cantidad de registros a ignorar en la lista (paginación). Por defecto: 0.
active	boolean	No	Filtrar para retornar solo servicios activos (`true`) o inactivos (`false`).

📤 Estructura de la Respuesta

La respuesta retorna la lista de servicios encontrados según los filtros aplicados. Cada objeto de servicio incluye información como nombre, valor, disponibilidad para entradas, venta online y observaciones comerciales.

Campo	Tipo	Descripción
idService	int32	ID único del servicio.
idBranch	int32	ID de la sucursal asociada al servicio.
nameService	string	Nombre del servicio.
value	number	Valor del servicio.
allowEntries	boolean	Indica si el servicio permite registros de entrada.
experimentalClass	boolean	Indica si el servicio permite clase experimental.
maxAmountInstallments	int32	Cantidad máxima de cuotas permitidas para la venta del servicio.
urlSale	string	URL para la venta online del servicio.
inactive	boolean	Indica si el servicio está inactivo (`true`) o activo (`false`).
onlineSalesObservations	string	Observaciones adicionales sobre la venta online del servicio.
allowsUseoftheServiceinExternalIntegration	boolean	Indica si el servicio permite integraciones externas para ventas.
needConferenceAvailabilityScheduling	boolean	Indica si el servicio requiere verificación de disponibilidad para agendamiento.
activityGroups	arrayobject	Grupo de actividades. Ver más abajo.
activityGroupsToSerialize	arrayobject	Grupo de actividades para serializar. Ver más abajo.

🧩 Estructura de `activityGroups` y `activityGroupsToSerialize`

Campo	Tipo	Descripción
idActivityGroup	int32	ID único del grupo de actividades.
nameActivityGroup	string	Nombre del grupo de actividades.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "idService": 0,
        "idBranch": 0,
        "nameService": "string",
        "value": 0,
        "allowEntries": true,
        "experimentalClass": true,
        "maxAmountInstallments": 0,
        "urlSale": "string",
        "inactive": true,
        "onlineSalesObservations": "string",
        "allowsUseoftheServiceinExternalIntegration": true,
        "needConferenceAvailabilityScheduling": true,
        "showActivities": true,
        "activityGroups": [
            {
                "idActivityGroup": 0,
                "nameActivityGroup": "string"
            }
        ],
        "activityGroupsToSerialize": [
            {
                "idActivityGroup": 0,
                "nameActivityGroup": "string"
            }
        ]
    }
]

🟠400Bad Request

Get services

Listar Servicios#

Descripción#

🔑 Parámetros de Consulta (Query Params)#

📤 Estructura de la Respuesta#

🧩 Estructura de activityGroups y activityGroupsToSerialize#