Retornar Atividades para Agendamentos

Descrição

Retorna a lista de atividades cadastradas no módulo de agendamentos. Ideal para exibir atividades disponíveis para agendamento 1:1 no aplicativo, site ou sistemas integrados.

🔑 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

A resposta retorna uma lista de atividades configuradas para agendamento, incluindo informações gerais da atividade, grupos, disponibilidade, recursos, profissionais e detalhes de exibição.

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").

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

Retornar Atividades para Agendamentos#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#

📤 Estrutura de Resposta#

🧩 Estrutura de audience#

🧩 Estrutura de employees#

🧩 Estrutura de resources#

🧩 Estrutura de areas#

🧩 Estrutura de unavailabilities#

Requisição