Get activities
GET
https://evo-integracao-api.w12app.com.br/api/v1/appointments/activities
🌐 API Reference/Appointments
Retornar Atividades para Agendamentos
Descrição
🛂 A permissão no EVO que libera o acesso a este endpoint é o Atividade - Consulta.
🔑 Parâmetros de Consulta (Query Params)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| search | string | Não | Filtrar pelo nome da atividade, nome do grupo ou tags relacionadas. |
| idBranch | int32 | Recomendável | Filtrar pelo número da filial. Recomendado para cenários com múltiplas filiais (multilocation). |
| take | int32 | Não | Total de atividades a serem retornadas. Valor padrão: 10. |
| skip | int32 | Não | Total de atividades a serem ignoradas (para paginação). Valor padrão: 0. |
📤 Estrutura de Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| idActivity | int32 | Identificador único da atividade. |
| photo | string | URL da foto associada à atividade (se disponível). |
| name | string | Nome da atividade. |
| activityGroup | string | Nome do grupo ao qual a atividade pertence. |
| totalRecords | int32 | Quantidade total de registros associados ao resultado (útil para paginação). |
| inactive | boolean | Indica se a atividade está inativa. |
| description | string | Descrição completa da atividade. |
| idActivityGroup | int32 | ID do grupo ao qual a atividade pertence. |
| showOnMobile | boolean | Indica se a atividade deve ser exibida no aplicativo mobile. |
| showOnWebsite | boolean | Indica se a atividade deve ser exibida no website. |
| idBranch | int32 | ID da filial onde a atividade está cadastrada. |
| audience | arrayobject | Lista de públicos vinculados à atividade. Veja mais a seguir. |
| idAudience | int32 | ID do público-alvo principal da atividade. |
| code | string | Código interno da atividade. |
| employees | arrayobject | Lista de colaboradores associados à atividade. Veja mais a seguir. |
| resources | arrayobject | Lista de recursos necessários ou associados à atividade. Veja mais a seguir. |
| areas | arrayobject | Locais ou ambientes onde a atividade pode ocorrer. Veja mais a seguir. |
| unavailabilities | arrayobject | Horários em que a atividade não pode ser realizada. Veja mais a seguir. |
🧩 Estrutura de audience
| Campo | Tipo | Descrição |
|---|---|---|
| idPublicoAtividade | int32 | ID do vínculo entre atividade e público. |
| idFilial | int32 | ID da filial referente ao público. |
| nome | string | Nome do público-alvo da atividade. |
🧩 Estrutura de employees
| Campo | Tipo | Descrição |
|---|---|---|
| idActivityEmployee | int32 | ID do vínculo entre o colaborador e a atividade. |
| idEmployee | int32 | ID do colaborador. |
| name | string | Nome do colaborador. |
| idActivity | int32 | ID da atividade. |
🧩 Estrutura de resources
| Campo | Tipo | Descrição |
|---|---|---|
| idActivityResource | int32 | ID do vínculo entre o recurso e a atividade. |
| idActivity | int32 | ID da atividade. |
| name | string | Nome do recurso. |
| idResource | int32 | ID do recurso. |
🧩 Estrutura de areas
| Campo | Tipo | Descrição |
|---|---|---|
| idActivityArea | int32 | ID do vínculo entre a área e a atividade. |
| idActivity | int32 | ID da atividade. |
| idArea | int32 | ID da área. |
| name | string | Nome da área. |
🧩 Estrutura de unavailabilities
| Campo | Tipo | Descrição |
|---|---|---|
| idUnavailability | int32 | ID da indisponibilidade configurada. |
| startTime | object | Data/hora de início da indisponibilidade (estrutura de TimeSpan). |
| endTime | object | Data/hora de término da indisponibilidade (estrutura de TimeSpan). |
| weekDay | string | Dia da semana da indisponibilidade (ex.: "Monday"). |
Request
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/appointments/activities?search=undefined&idBranch=undefined&take=undefined&skip=undefined' \
--header 'Authorization: Basic <encoded-value>'Response Response Example
200 - Example 1
[
{
"idActivity": 0,
"photo": "string",
"name": "string",
"activityGroup": "string",
"totalRecords": 0,
"inactive": true,
"description": "string",
"idActivityGroup": 0,
"showOnMobile": true,
"showOnWebsite": true,
"idBranch": 0,
"audience": [
{
"idPublicoAtividade": 0,
"idFilial": 0,
"nome": "string"
}
],
"idAudience": 0,
"code": "string",
"employees": [
{
"idActivityEmployee": 0,
"idEmployee": 0,
"name": "string",
"idActivity": 0
}
],
"resources": [
{
"idActivityResource": 0,
"idActivity": 0,
"name": "string",
"idResource": 0
}
],
"areas": [
{
"idActivityArea": 0,
"idActivity": 0,
"idArea": 0,
"name": "string"
}
],
"unavailabilities": [
{
"idUnavailability": 0,
"startTime": "string",
"endTime": "string",
"weekDay": "string"
}
]
}
]Modified at 2026-05-15 04:38:45