Obtener Lista de Actividades

Descripción

Recupera una lista de actividades, cada una con información detallada, incluyendo nombre, grupo, público y otros datos relevantes.

OBS. Disponible para uso con clave de acceso de sucursal y también con clave de acceso de ADM General.

🔑 Parámetros de Consulta (Query Params)

Este endpoint no requiere parámetros obligatorios, sin embargo en un escenario con gran número de sucursales, recomendamos informar el idBranch de la sucursal asociada a las actividades deseadas.

Parâmetro	Tipo	Obrigatório	Descripción
search	string	No	Filtrar por el nombre de la actividad, grupo o etiquetas
idBranch	int32	Recomendado	Filtrar por el número de sucursal (recomendado para escenarios multisucursal)
take	int32	No	Total de actividades registradas a ser devueltas. 10 por defecto.
skip	int32	No	Total de actividades registradas a ser ignoradas.

📤 Estructura de la Respuesta

La respuesta es un array de objetos de actividades con la siguiente estructura:

Campo	Tipo	Descripción
`idActivity`	int32	Identificador único de la actividad.
`photo`	string	URL de la foto de la actividad.
`name`	string	Nombre de la actividad.
`color`	string	Código de color asociado a la actividad.
`activityGroup`	string	Nombre del grupo de la actividad.
`totalRecords`	int32	Número total de registros asociados a la actividad.
`inactive`	booleano	Indica si la actividad está inactiva (`true` o `false`).
`description`	string	Descripción detallada de la actividad.
`idActivityGroup`	int32	Identificador del grupo de la actividad.
`showOnMobile`	boolean	Indica si la actividad se muestra en el móvil (`true` o `false`).
`showOnWebsite`	boolean	Indica si la actividad se muestra en el sitio web (`true` o `false`).
`idBranch`	inteiro	Identificador de la sucursal asociada a la actividad.
`audience`	array	Lista de objetos de público objetivo de la actividad.
`idAudience`	int32	Identificador del público objetivo de la actividad.

🧩 Estructura del Objeto `audience`

Campo	Tipo	Descripción
`idPublicoAtividade`	int32	Identificador del público objetivo específico de la actividad.
`idFilial`	int32	Identificador de la sucursal asociada al público.
`nome`	string	Nombre del público objetivo.

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",
        "color": "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"
    }
]

🟠400Bad Request

Get activities

Obtener Lista de Actividades#

Descripción#

🔑 Parámetros de Consulta (Query Params)#

📤 Estructura de la Respuesta#

🧩 Estructura del Objeto audience#