Listar Serviços

Descrição

Retorna a lista de serviços cadastrados no sistema, permitindo filtragem por ID, nome, filial e status (ativo/inativo). Os resultados podem ser paginados por meio dos parâmetros take e skip.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatoriedade	Descrição
idService	int32	Não	Filtrar pelo ID específico do serviço.
name	string	Não	Filtrar pelo nome do serviço.
idBranch	int32	Recomendável	Filtrar pelo número da filial (somente aplicável para chaves multilocal; ignorado caso contrário).
take	int32	Não	Quantidade de registros a serem retornados (máximo 50). Padrão: 25.
skip	int32	Não	Quantidade de registros a serem ignorados na listagem (paginação). Padrão: 0.
active	boolean	Não	Filtrar para retornar apenas serviços ativos (`true`) ou inativos (`false`).
showOnlyExternalIntegrationServices	boolean	Não	Filtrar serviços que permitem vendas de integrações externas.

📤 Estrutura da Resposta

A resposta retorna a lista de serviços encontrados com base nos filtros informados. Cada objeto de serviço inclui informações como nome, valor, disponibilidade para entradas, venda online e observações comerciais.

Campo	Tipo	Descrição
idService	int32	ID único do serviço.
idBranch	int32	ID da filial associada ao serviço.
nameService	string	Nome do serviço.
value	number	Valor do serviço.
allowEntries	boolean	Indica se o serviço permite lançamentos de entrada.
experimentalClass	boolean	Indica se o serviço permite aula experimental.
maxAmountInstallments	int32	Quantidade máxima de parcelas permitidas para a venda do serviço.
urlSale	string	URL para venda do serviço online.
inactive	boolean	Indica se o serviço está inativo (`true`) ou ativo (`false`).
onlineSalesObservations	string	Observações adicionais sobre a venda online do serviço.
allowsUseoftheServiceinExternalIntegration	boolean	Indica se o serviço permite integrações externas para vendas.
needConferenceAvailabilityScheduling	boolean	Indica se o serviço precisa de conferência de disponibilidade para agendamento.
activityGroups	arrayobject	Grupo de atividades

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 Serviços#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#