Get Activities Schedule

Description

Retrieves a detailed schedule of activities, including information such as date, time, location, capacity, and specific details about the instructor and the activity setup.

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

🔑 Query Parameters

This endpoint can include optional parameters to filter the activities schedule. In scenarios with a large number of branches, it is recommended to provide the idBranch of the branch associated with the desired activities. Continue reading this section of the documentation for more details on the available parameters.

Parameter	Type	Required	Description
idMember	int32	No	Filters by member
take	int32	No	Total number of records to be returned
onlyAvailables	boolean	No	Filters for available activities. false by default.
date	date-time	No	Filters for a specific date.
showFullWeek	boolean	No	Shows all activities of the week.
idBranch	int32	Recommended	Filters by branch.
idActivities	string	No	Filters by activity IDs. Provide the IDs separated by commas.
idAudiences	string	No	Filters by audience IDs. Provide the IDs separated by commas.
idBranchToken	string	No	Filters by a different branch than the current one.
origin	int32	No	Filters by origin.
experimentalClass	boolean	No	Filter to return only experimental (`true`) or non-experimental (`false`) activities.

📤 Response Structure

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

Field	Type	Description
`idConfiguration`	integer	Unique identifier of the activity configuration.
`idActivity`	integer	Unique identifier for the activity.
`idAtividadeSessao`	integer	Identifier of the activity session.
`idGroupActivity`	integer	Identifier of the group of activities to which it belongs.
`name`	string	Name of the activity.
`description`	string	Detailed description of the activity.
`imageUrl`	string	URL of the activity image.
`area`	string	Area where the activity will take place.
`idArea`	integer	Identifier of the activity area.
`capacity`	integer	Maximum capacity of participants for the activity.
`ocupation`	integer	Number of occupied spots.
`allowChoosingSpot`	boolean	Indicates if choosing a specific spot is allowed (`true` or `false`).
`startTime`	string	Start time of the activity (format HH:MM).
`endTime`	string	End time of the activity (format HH:MM).
`bookingStartTime`	string	Start time for bookings (format HH:MM).
`bookingEndTime`	string	End time for bookings (format HH:MM).
`instructor`	string	Name of the instructor responsible for the activity.
`instructorPhoto`	string	URL of the instructor's photo.
`activityDate`	datetime	Date of the activity (ISO 8601 format).
`audience`	string	Target audience of the activity.
`idAudience`	integer	Identifier of the target audience.
`code`	string	Identifier code of the activity.
`confirmed`	boolean	Indicates if the activity is confirmed (`true` or `false`).
`spots`	array	List of available seats/spots for the activity (detailed below).
`periodization`	array	List of periodization settings (detailed below).
`status`	integer	Status code of the activity.
`statusName`	string	Name of the activity status.
`memberStatus`	string	Member's status in the activity.
`allowExperimentalClass`	boolean	Indicates whether scheduling a trial class is allowed.
`experimentalClassSlots`	int32	Number of available slots for the trial class.
`limitAgeRange`	boolean	Indicates whether there is an age range limit for scheduling.
`ageRangeFrom`	int32	Initial age allowed for scheduling.
`ageRangeFromInMonths`	boolean	Indicates whether the initial age is expressed in months.
`ageRangeTo`	int32	Final age allowed for scheduling.
`ageRangeToInMonths`	boolean	Indicates whether the final age is expressed in months.

🧩 Structure of the `spots` Object

Field	Type	Description
`number`	integer	Seat or spot number.
`available`	boolean	Indicates if the seat is available (`true` or `false`).
`nameSpot`	string	Name or identification of the seat.

🧩 Structure of the `periodization` Object

Field	Type	Description
`name`	string	Name of the periodization.
`characteristics`	string	Specific characteristics of the periodization.
`color`	string	Color code associated with the periodization.
`intensityNumber`	integer	Intensity level associated with the periodization.
`type`	string	Type of periodization.

🔷 Activity Status

Status	Description	Value
Free	Class configured as free in the system (Evo).	0
Available	Class can be scheduled.	1
Full	Class is full, scheduling is not possible, waiting list is active.	2
Reservation Closed	Class can no longer be scheduled because the time has passed.	3
Restricted	Member does not have the right to participate, needs to purchase a contract to have the right.	4
Registered	Member is already registered in the class.	5
Completed	Class marked as completed in Evo.	6
Cancelled	Class cancelled in Evo.	7
In Line	Class was full and the member entered the waiting list.	8
Free Closed	Class configured as free in Evo and has already been completed.	10
Restricted Closed	Restricted class and has already been completed in Evo.	11
Restricted Does Not Allow Participation	Class does not allow scheduling, only in-person participation.	12
Full Without Waiting List	Class is full and does not allow the member to enter the waiting list.	15

🔷 Structure of the `Origin` Enum

Value	Name	Description
0	WalkInReception	Type of origin for walk-in reception.
1	WeeklyReception	Type of origin for weekly reception.
2	Mobile	Origin related to mobile devices.
3	Kiosk	Origin associated with the use of kiosks.
4	Enrollment	Origin related to the enrollment process.
5	Link	Origin associated with shared links.
6	Gympass	Origin associated with Gympass.
7	ClassPass	Origin associated with ClassPass.
8	WorkoutPrint	Origin associated with workout printing.
9	TotalPass	Origin related to TotalPass.
10	External	Origin from an external source.
11	YourGuru	Origin associated with YourGuru.
12	MyWellness	Origin related to MyWellness.

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

[
    {
        "idConfiguration": 0,
        "idActivity": 0,
        "idAtividadeSessao": 0,
        "idGroupActivity": 0,
        "name": "string",
        "description": "string",
        "imageUrl": "string",
        "area": "string",
        "idArea": 0,
        "capacity": 0,
        "ocupation": 0,
        "allowChoosingSpot": true,
        "startTime": "string",
        "endTime": "string",
        "bookingStartTime": "string",
        "bookingEndTime": "string",
        "instructor": "string",
        "instructorPhoto": "string",
        "activityDate": "2019-08-24T14:15:22.123Z",
        "audience": "string",
        "idAudience": 0,
        "code": "string",
        "confirmed": true,
        "spots": [
            {
                "number": 0,
                "available": true,
                "nameSpot": "string"
            }
        ],
        "periodization": [
            {
                "name": "string",
                "characteristics": "string",
                "color": "string",
                "intensityNumber": 0,
                "type": "string"
            }
        ],
        "status": 0,
        "statusName": "string",
        "memberStatus": "string",
        "allowExperimentalClass": true,
        "experimentalClassSlots": 0,
        "limitAgeRange": true,
        "ageRangeFrom": 0,
        "ageRangeFromInMonths": true,
        "ageRangeTo": 0,
        "ageRangeToInMonths": true
    }
]

🟠400Bad Request

Get activities schedule

Get Activities Schedule#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Structure of the spots Object#

🧩 Structure of the periodization Object#

🔷 Activity Status#

🔷 Structure of the Origin Enum#

Request