Get Activities Schedule by idService or idMembership

Description

This endpoint returns the available activity schedules for booking, considering the rules of availability and class occupancy.

🔑 Query Parameters

The query can be made using either a service ID or a membership ID, always limiting the period to a maximum of 7 days.

It is MANDATORY to provide either idService or idMembership (one of the two).

Parameter	Type	Required	Description
idService	int32	Situational	Filter by the identification of a service. Required if `idMembership` is not provided.
idMembership	int32	Situational	Filter by the identification of a membership. Required if `idService` is not provided.
startDate	string(date-time)	Yes	Start date of the query.
endDate	string(date-time)	No	End date of the query. If not provided, assumes `startDate + 7 days`. Always limited to a maximum period of 7 days.
idBranch	int32	No	Filter by the branch. Recommended for scenarios with multiple branches.
idActivities	string	No	One or more activity IDs separated by commas (e.g., `101,102,103`).
AllowEnrollment	boolean	No	Filter all future schedules, returning only activities/times that have available spots.

Response Structure

The response returns a list of available activities in the requested period, bringing only the times still available for booking, respecting capacity, branch, and activity restrictions.

Field	Type	Description
idConfiguration	int32	Identifier of the activity configuration.
idActivity	int32	Identifier of the activity.
name	string	Name of the activity.
idGroupActivity	int32	Identifier of the activity group.
activityGroup	string	Name of the activity group.
description	string	Description of the activity.
activityDate	string(date-time)	Date of the activity.
startTime	string	Start time of the activity.
endTime	string	End time of the activity.
area	string	Name of the area/location where the activity occurs.
idArea	int32	Identifier of the area.
allowChoosingSpot	boolean	Indicates if it is allowed to choose the spot in the activity.
capacity	int32	Total capacity of the activity.
occupation	int32	Number of spots already occupied.
idActivitySession	int32	Identifier of the activity session.
availableOnHoliday	boolean	Indicates if the activity is available on holidays.
status	int32	Status code of the activity.
statusName	string	Name of the status of the activity.
spots	array	List of available spots.

🧩 Structure of the `spots` Object

Field	Type	Description
number	int32	Number of the spot.
available	boolean	Indicates if the spot is available.
nameSpot	string	Name or identifier of the spot.

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,
        "name": "string",
        "idGroupActivity": 0,
        "activityGroup": "string",
        "description": "string",
        "activityDate": "2019-08-24T14:15:22.123Z",
        "horaTick": 0,
        "duracaoTick": 0,
        "startTime": "string",
        "endTime": "string",
        "area": "string",
        "idArea": 0,
        "allowChoosingSpot": true,
        "capacity": 0,
        "ocupation": 0,
        "idActivitySession": 0,
        "availableOnHoliday": true,
        "status": 0,
        "statusName": "string",
        "spots": [
            {
                "number": 0,
                "available": true,
                "nameSpot": "string"
            }
        ]
    }
]

🟠400Bad Request

Get activities schedule by idService or idMembership

Get Activities Schedule by idService or idMembership#

Description#

🔑 Query Parameters#

Response Structure#

🧩 Structure of the spots Object#