Devolver Actividades para Agendamientos

Descripción

Devuelve la lista de actividades registradas en el módulo de agendamientos. Ideal para mostrar actividades disponibles para reservas 1:1 en la aplicación, sitio web o sistemas integrados.

🛂 El permiso en EVO que habilita el acceso a este endpoint es Actividad - Consulta.

🔑 Parámetros de Consulta (Query Params)

Parámetro	Tipo	Obligatorio	Descripción
search	string	No	Filtrar por el nombre de la actividad, nombre del grupo o tags relacionadas.
idBranch	int32	Recomendado	Filtrar por el número de la sucursal. Recomendado para escenarios con múltiples sucursales (multilocation).
take	int32	No	Total de actividades que serán devueltas. Valor predeterminado: 10.
skip	int32	No	Total de actividades que serán ignoradas (para paginación). Valor predeterminado: 0.

📤 Estructura de la Respuesta

La respuesta devuelve una lista de actividades configuradas para agendamiento, incluyendo información general de la actividad, grupos, disponibilidad, recursos, profesionales y detalles de visualización.

Campo	Tipo	Descripción
idActivity	int32	Identificador único de la actividad.
photo	string	URL de la foto asociada a la actividad (si está disponible).
name	string	Nombre de la actividad.
activityGroup	string	Nombre del grupo al que pertenece la actividad.
totalRecords	int32	Cantidad total de registros asociados al resultado (útil para paginación).
inactive	boolean	Indica si la actividad está inactiva.
description	string	Descripción completa de la actividad.
idActivityGroup	int32	ID del grupo al que pertenece la actividad.
showOnMobile	boolean	Indica si la actividad debe mostrarse en la aplicación móvil.
showOnWebsite	boolean	Indica si la actividad debe mostrarse en el sitio web.
idBranch	int32	ID de la sucursal donde la actividad está registrada.
audience	arrayobject	Lista de públicos vinculados a la actividad. Ver más abajo.
idAudience	int32	ID del público objetivo principal de la actividad.
code	string	Código interno de la actividad.
employees	arrayobject	Lista de colaboradores asociados a la actividad. Ver más abajo.
resources	arrayobject	Lista de recursos necesarios o asociados a la actividad. Ver más abajo.
areas	arrayobject	Lugares o ambientes donde la actividad puede realizarse. Ver más abajo.
unavailabilities	arrayobject	Horarios en los que la actividad no puede realizarse. Ver más abajo.

🧩 Estructura de `audience`

Campo	Tipo	Descripción
idPublicoAtividade	int32	ID del vínculo entre actividad y público.
idFilial	int32	ID de la sucursal referente al público.
nome	string	Nombre del público objetivo de la actividad.

🧩 Estructura de `employees`

Campo	Tipo	Descripción
idActivityEmployee	int32	ID del vínculo entre el colaborador y la actividad.
idEmployee	int32	ID del colaborador.
name	string	Nombre del colaborador.
idActivity	int32	ID de la actividad.

🧩 Estructura de `resources`

Campo	Tipo	Descripción
idActivityResource	int32	ID del vínculo entre el recurso y la actividad.
idActivity	int32	ID de la actividad.
name	string	Nombre del recurso.
idResource	int32	ID del recurso.

🧩 Estructura de `areas`

Campo	Tipo	Descripción
idActivityArea	int32	ID del vínculo entre el área y la actividad.
idActivity	int32	ID de la actividad.
idArea	int32	ID del área.
name	string	Nombre del área.

🧩 Estructura de `unavailabilities`

Campo	Tipo	Descripción
idUnavailability	int32	ID de la indisponibilidad configurada.
startTime	object	Fecha/hora de inicio de la indisponibilidad (estructura de TimeSpan).
endTime	object	Fecha/hora de fin de la indisponibilidad (estructura de TimeSpan).
weekDay	string	Día de la semana de la indisponibilidad (ej.: "Monday").

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

[
    {
        "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": {
                    "ticks": 0,
                    "days": 0,
                    "hours": 0,
                    "milliseconds": 0,
                    "microseconds": 0,
                    "nanoseconds": 0,
                    "minutes": 0,
                    "seconds": 0,
                    "totalDays": 0,
                    "totalHours": 0,
                    "totalMilliseconds": 0,
                    "totalMicroseconds": 0,
                    "totalNanoseconds": 0,
                    "totalMinutes": 0,
                    "totalSeconds": 0
                },
                "endTime": {
                    "ticks": 0,
                    "days": 0,
                    "hours": 0,
                    "milliseconds": 0,
                    "microseconds": 0,
                    "nanoseconds": 0,
                    "minutes": 0,
                    "seconds": 0,
                    "totalDays": 0,
                    "totalHours": 0,
                    "totalMilliseconds": 0,
                    "totalMicroseconds": 0,
                    "totalNanoseconds": 0,
                    "totalMinutes": 0,
                    "totalSeconds": 0
                },
                "weekDay": "string"
            }
        ]
    }
]

🟠400Bad Request

Get activities

Devolver Actividades para Agendamientos#

Descripción#

🔑 Parámetros de Consulta (Query Params)#

📤 Estructura de la Respuesta#

🧩 Estructura de audience#

🧩 Estructura de employees#

🧩 Estructura de resources#

🧩 Estructura de areas#

🧩 Estructura de unavailabilities#

Requisição