Get List of Activities

Description

Retrieves a list of activities, each with detailed information, including name, group, audience, and other relevant data.

NOTE. Available for use with branch access key and also with General ADM access key.

🔑 Query Parameters

This endpoint does not require mandatory parameters, but in a scenario with a large number of branches, it is recommended to provide the idBranch of the branch associated with the desired activities.

Parameter	Type	Required	Description
search	string	No	Filter by the name of the activity, group, or tags
idBranch	int32	Recommended	Filter by branch number (recommended for multi-branch scenarios)
take	int32	No	Total number of registered activities to be returned. 10 by default.
skip	int32	No	Total number of registered activities to be ignored.

📤 Response Structure

The response is an array of activity objects with the following structure:

Field	Type	Description
`idActivity`	integer	Unique identifier for the activity.
`photo`	string	URL of the activity photo.
`name`	string	Name of the activity.
`color`	string	Color code associated with the activity.
`activityGroup`	string	Name of the activity group.
`totalRecords`	integer	Total number of records associated with the activity.
`inactive`	boolean	Indicates if the activity is inactive (`true` or `false`).
`description`	string	Detailed description of the activity.
`idActivityGroup`	integer	Identifier of the activity group.
`showOnMobile`	boolean	Indicates if the activity is displayed on mobile (`true` or `false`).
`showOnWebsite`	boolean	Indicates if the activity is displayed on the website (`true` or `false`).
`idBranch`	integer	Identifier of the branch associated with the activity.
`audience`	array	List of target audience objects for the activity.
`idAudience`	integer	Identifier of the target audience for the activity.

🧩 Structure of the `audience` Object

Field	Type	Description
`idPublicoAtividade`	integer	Identifier of the specific target audience for the activity.
`idFilial`	integer	Identifier of the branch associated with the audience.
`nome`	string	Name of the target audience.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

[
    {
        "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

Get List of Activities#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Structure of the audience Object#