Get services
GET
https://evo-integracao-api.w12app.com.br/api/v1/service
🌐 API Reference/Service
Listar Serviços
Descrição
🔑 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). |
| showOnlyExternalIntegrationServices | boolean | Não | Filtrar serviços que permitem vendas de integrações externas. |
| showActivities | boolean | Não | Mostrar atividades. |
| 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). |
📤 Estrutura da Resposta
| 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. Ver mais abaixo. |
| activityGroupsToSerialize | arrayobject | Grupo de atividades para serializar. Ver mais abaixo. |
🧩 Estrutura de activityGroups e activityGroupsToSerialize
| Campo | Tipo | Descrição |
|---|---|---|
| idActivityGroup | int32 | ID único do grupo de atividades. |
| nameActivityGroup | string | Nome do grupo de atividades. |
Request
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/service?idService=undefined&name=undefined&idBranch=undefined&showOnlyExternalIntegrationServices=undefined&showActivities=undefined&take=undefined&skip=undefined&active=undefined' \
--header 'Authorization: Basic <encoded-value>'Response Response Example
200 - Example 1
[
{
"idService": 0,
"idBranch": 0,
"nameService": "string",
"value": 0,
"allowEntries": true,
"experimentalClass": true,
"maxAmountInstallments": 0,
"urlSale": "string",
"inactive": true,
"onlineSalesObservations": "string",
"allowsUseoftheServiceinExternalIntegration": true,
"needConferenceAvailabilityScheduling": true,
"activityGroups": [
{
"idActivityGroup": 0,
"nameActivityGroup": "string"
}
]
}
]Modified at 2026-05-15 04:38:45