get https://evo-integracao-api.w12app.com.br/api/v1/activities
Permite obter uma lista de atividades disponíveis.
Obter Lista de Atividades
Descrição
Recupera uma lista de atividades, cada uma com informações detalhadas, incluindo nome, grupo, público e outros dados relevantes.
Parâmetros de Consulta
Este endpoint não requer parâmetros obrigatórios, porém em um cenário de grande número de filiais, recomendamos informar o idBranch da filial associada às atividades desejadas.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| search | string | Não | Filtrar pelo nome da atividade, grupo ou tags |
| idBranch | int32 | Recomendável | Filtrar pelo número de filial (recomendado para cenários de multifiliais) |
| take | int32 | Não | Total de atividades registradas a serem retornadas. 10 por padrão. |
| skip | int32 | Não | Total de atividades registradas a serem ignoradas. |
Resposta
A resposta é um array de objetos de atividades com a seguinte estrutura:
| Campo | Tipo | Descrição |
|---|---|---|
idActivity | inteiro | Identificador único para a atividade. |
photo | string | URL da foto da atividade. |
name | string | Nome da atividade. |
color | string | Código de cor associado à atividade. |
activityGroup | string | Nome do grupo da atividade. |
totalRecords | inteiro | Número total de registros associados à atividade. |
inactive | booleano | Indica se a atividade está inativa (true ou false). |
description | string | Descrição detalhada da atividade. |
idActivityGroup | inteiro | Identificador do grupo da atividade. |
showOnMobile | booleano | Indica se a atividade é exibida no mobile (true ou false). |
showOnWebsite | booleano | Indica se a atividade é exibida no website (true ou false). |
idBranch | inteiro | Identificador da filial associada à atividade. |
audience | array | Lista de objetos de público-alvo da atividade. |
idAudience | inteiro | Identificador do público-alvo da atividade. |
Estrutura do Objeto audience
audience| Campo | Tipo | Descrição |
|---|---|---|
idPublicoAtividade | inteiro | Identificador do público-alvo específico da atividade. |
idFilial | inteiro | Identificador da filial associada ao público. |
nome | string | Nome do público-alvo. |
Exemplo de requisição
{
"search": "atividade",
"idBranch": 123,
"take": 10,
"skip": 0
}