Return Activities for Scheduling

Description

Returns the list of activities registered in the scheduling module. Ideal for displaying activities available for 1:1 scheduling in the app, website, or integrated systems.

🛂 The permission in EVO that grants access to this endpoint is Activity - Query.

🔑 Query Parameters

Parameter	Type	Required	Description
search	string	No	Filter by the name of the activity, group name, or related tags.
idBranch	int32	Recommended	Filter by the branch number. Recommended for scenarios with multiple branches (multilocation).
take	int32	No	Total number of activities to be returned. Default value: 10.
skip	int32	No	Total number of activities to be skipped (for pagination). Default value: 0.

📤 Response Structure

The response returns a list of activities configured for scheduling, including general information about the activity, groups, availability, resources, professionals, and display details.

Field	Type	Description
idActivity	int32	Unique identifier of the activity.
photo	string	URL of the photo associated with the activity (if available).
name	string	Name of the activity.
activityGroup	string	Name of the group to which the activity belongs.
totalRecords	int32	Total number of records associated with the result (useful for pagination).
inactive	boolean	Indicates if the activity is inactive.
description	string	Complete description of the activity.
idActivityGroup	int32	ID of the group to which the activity belongs.
showOnMobile	boolean	Indicates if the activity should be displayed in the mobile app.
showOnWebsite	boolean	Indicates if the activity should be displayed on the website.
idBranch	int32	ID of the branch where the activity is registered.
audience	arrayobject	List of audiences linked to the activity. See more below.
idAudience	int32	ID of the main target audience of the activity.
code	string	Internal code of the activity.
employees	arrayobject	List of staff members associated with the activity. See more below.
resources	arrayobject	List of resources needed or associated with the activity. See more below.
areas	arrayobject	Locations or environments where the activity can occur. See more below.
unavailabilities	arrayobject	Times when the activity cannot be performed. See more below.

🧩 Structure of `audience`

Field	Type	Description
idPublicoAtividade	int32	ID of the link between activity and audience.
idFilial	int32	ID of the branch related to the audience.
nome	string	Name of the target audience of the activity.

🧩 Structure of `employees`

Field	Type	Description
idActivityEmployee	int32	ID of the link between the staff member and the activity.
idEmployee	int32	ID of the staff member.
name	string	Name of the staff member.
idActivity	int32	ID of the activity.

🧩 Structure of `resources`

Field	Type	Description
idActivityResource	int32	ID of the link between the resource and the activity.
idActivity	int32	ID of the activity.
name	string	Name of the resource.
idResource	int32	ID of the resource.

🧩 Structure of `areas`

Field	Type	Description
idActivityArea	int32	ID of the link between the area and the activity.
idActivity	int32	ID of the activity.
idArea	int32	ID of the area.
name	string	Name of the area.

🧩 Structure of `unavailabilities`

Field	Type	Description
idUnavailability	int32	ID of the configured unavailability.
startTime	object	Start date/time of the unavailability (TimeSpan structure).
endTime	object	End date/time of the unavailability (TimeSpan structure).
weekDay	string	Day of the week of the unavailability (e.g., "Monday").

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",
        "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": "string",
                "endTime": "string",
                "weekDay": "string"
            }
        ]
    }
]

🟠400Bad Request

Get activities

Return Activities for Scheduling#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Structure of audience#

🧩 Structure of employees#

🧩 Structure of resources#

🧩 Structure of areas#

🧩 Structure of unavailabilities#

Request