Get Basic Member Information

Description

This endpoint allows you to obtain basic information about the member, but does not return sensitive information.

🛂 The permission in EVO that grants access to this endpoint is Customer - Query without sensitive data.

🚧 NOTE. To return any member, at least one of the following parameters must be provided: email, document, phone, or idMember.
Available for use with branch access key and also with General ADM access key.

🔑 Query Parameter

Parameter	Type	Required	Description
email	string	No	Member's email.
document	string	No	Member's document.
phone	string	No	Member's mobile phone.
idMember	int32	No	Member's ID.
take	int32	No	Total number of values to return. (Maximum 50)
skip	int32	No	Total number of values to skip (ignore).

📤 Response Structure

Field	Type	Description
`idMember`	number	Unique identifier of the member.
`firstName`	string	Member's first name.
`lastName`	string	Member's last name.
`registerName`	string	Name registered in the record.
`registerLastName`	string	Last name registered in the record.
`usePreferredName`	boolean	Indicates whether the system should use the preferred name.
`registerDate`	datetime	Date of member registration.
`idBranch`	number	Identifier of the branch associated with the member.
`branchName`	string	Name of the branch associated with the member.
`accessBlocked`	boolean	Indicates whether the member's access is blocked.
`blockedReason`	string	Reason for access blockage, when applicable.
`gender`	string	Member's gender.
`birthDate`	datetime	Member's date of birth.
`accessCardNumber`	string	Member's access card number.
`membershipStatus`	string	Overall status of the member's membership.
`penalized`	boolean	Indicates whether the member is penalized.
`status`	string	Member's status in the system.
`contacts`	array	List of the member's contacts. (see details below)
`memberships`	array	List of the member's memberships (plans/contracts). (see details below)
`lastAccessDate`	datetime	Date of the member's last access.
`idEmployeeConsultant`	number	Identifier of the consultant staff member associated with the member.
`nameEmployeeConsultant`	string	Name of the consultant staff member associated with the member.
`idEmployeeInstructor`	number	Identifier of the instructor staff member associated with the member.
`nameEmployeeInstructor`	string	Name of the instructor staff member associated with the member.
`idEmployeePersonalTrainer`	number	Identifier of the personal trainer associated with the member.
`nameEmployeePersonalTrainer`	string	Name of the personal trainer associated with the member.
`photoUrl`	string	URL of the member's photo.
`idMemberMigration`	string	Member's migration identifier.
`responsibles`	array	List of responsible parties linked to the member. (see details below)
`tokenGympass`	string	Integration token with Gympass.
`personalTrainer`	boolean	Indicates whether the member has a personal trainer.
`personalType`	string	Type of personal trainer associated with the member.

🧩 `contacts` Object

Field	Type	Description
`idPhone`	number	Identifier of the phone.
`idMember`	number	Identifier of the member associated with the contact.
`idEmployee`	number	Identifier of the staff member associated with the contact.
`idProspect`	number	Identifier of the prospect associated with the contact.
`idProvider`	number	Identifier of the provider associated with the contact.
`idContactType`	number	Identifier of the type of contact.
`contactType`	string	Description of the type of contact.
`ddi`	string	DDI code of the phone.
`description`	string	Description of the contact (e.g., number, notes).

🧩 `memberships` Object

Field	Type	Description
`idMember`	number	Identifier of the member.
`idMembership`	number	Identifier of the membership.
`idMemberMembership`	number	Identifier of the member-membership link.
`idMemberMembershipRenewed`	number	Identifier of the renewed membership, when applicable.
`numMembers`	number	Number of linked members.
`startDate`	datetime	Start date of the membership.
`endDate`	datetime	End date of the membership.
`name`	string	Name of the membership.
`cancelDate`	datetime	Cancellation date.
`cancelDateOn`	datetime	Effective cancellation date.
`cancelCreationDate`	datetime	Creation date of the cancellation.
`membershipStatus`	string	Status of the membership.
`valueNextMonth`	number	Expected value for the next month.
`nextCharge`	datetime	Date of the next charge.
`nextDateSuspension`	datetime	Next expected suspension date.
`idSale`	number	Identifier of the associated sale.
`saleDate`	datetime	Date of the sale.
`contractPrinting`	string	Contract printing information.
`freezes`	array	List of freezes of the membership. (see details below)
`idCategoryMembership`	number	Identifier of the membership category.
`numberSuspensionTimes`	number	Number of suspensions made.
`maxSuspensionDays`	number	Maximum days allowed for suspension.
`minimumSuspensionDays`	number	Minimum days allowed for suspension.
`disponibleSuspensionDays`	number	Available suspension days.
`disponibleSuspensionTimes`	number	Number of available suspensions.
`daysLeftToFreeze`	number	Days remaining for freezing.
`loyaltyEndDate`	datetime	End date of the loyalty period.
`assessmentEndDate`	datetime	End date of the assessment.
`acceptanceDate`	datetime	Date of contract acceptance.
`flAllowLocker`	boolean	Indicates if locker use is allowed.
`flAdditionalMembership`	boolean	Indicates if it is an additional membership.
`bioimpedanceAmount`	number	Number of available bioimpedances.
`signedTerms`	boolean	Indicates if the terms have been signed.
`originalValue`	number	Original value of the membership.
`allowLesMills`	boolean	Indicates if access to Les Mills is allowed.
`allowsCancellationByApp`	boolean	Indicates if cancellation via the app is allowed.
`contractSigningUrl`	string	URL for signing the contract.
`limitless`	boolean	Indicates if the membership is unlimited.
`weeklyLimit`	number	Weekly session limit.
`concludedSessions`	number	Completed sessions.
`pendingSessions`	number	Pending sessions.
`scheduledSessions`	number	Scheduled sessions.
`pendingRepositions`	number	Pending repositions.
`repositionsTotal`	number	Total repositions.
`bonusSessions`	number	Bonus sessions.
`sessions`	array	List of membership sessions. (see details below)

🧩 `memberships.freezes` Object

Field	Type	Description
`startSuspend`	datetime	Start date of the suspension.
`endSuspend`	datetime	End date of the suspension.
`unlockDate`	datetime	Release date of the suspension.
`idEmployee`	number	Identifier of the responsible staff member.
`reason`	string	Reason for the suspension.
`flUseMembershipFreezeDays`	boolean	Indicates if membership freeze days are used.
`daysFreeze`	number	Number of frozen days.
`idFreeze`	number	Identifier of the freeze.

🧩 `memberships.sessions` Object

Field	Type	Description
`idSession`	number	Identifier of the session.
`expirationDate`	datetime	Expiration date of the session.
`flBonusSession`	boolean	Indicates if it is a bonus session.

🧩 `responsibles` Object

Field	Type	Description
`idResponsible`	number	Identifier of the responsible party.
`idMember`	number	Identifier of the associated member.
`name`	string	Name of the responsible party.
`email`	string	Email of the responsible party.
`phone`	string	Phone of the responsible party.
`observation`	string	Observations about the responsible party.
`idMemberResponsible`	number	Identifier of the member-responsible link.
`acessFiti`	boolean	Indicates if access to Fiti is granted.
`financialResponsible`	boolean	Indicates if it is financially responsible.

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

{
    "idMember": 0,
    "firstName": "string",
    "lastName": "string",
    "registerName": "string",
    "registerLastName": "string",
    "usePreferredName": true,
    "registerDate": "2019-08-24T14:15:22.123Z",
    "idBranch": 0,
    "branchName": "string",
    "accessBlocked": true,
    "blockedReason": "string",
    "gender": "string",
    "birthDate": "2019-08-24T14:15:22.123Z",
    "accessCardNumber": "string",
    "membershipStatus": "string",
    "penalized": true,
    "status": "string",
    "contacts": [
        {
            "idPhone": 0,
            "idMember": 0,
            "idEmployee": 0,
            "idProspect": 0,
            "idProvider": 0,
            "idContactType": 1,
            "contactType": "string",
            "ddi": "string",
            "description": "string"
        }
    ],
    "memberships": [
        {
            "contractSigningUrl": "string",
            "limitless": true,
            "weeklyLimit": 0,
            "concludedSessions": 0,
            "pendingSessions": 0,
            "scheduledSessions": 0,
            "pendingRepositions": 0,
            "repositionsTotal": 0,
            "bonusSessions": 0,
            "sessions": [
                {
                    "idSession": 0,
                    "expirationDate": "2019-08-24T14:15:22.123Z",
                    "flBonusSession": true
                }
            ],
            "idMember": 0,
            "idMembership": 0,
            "idMemberMembership": 0,
            "idMemberMembershipRenewed": 0,
            "numMembers": 0,
            "startDate": "2019-08-24T14:15:22.123Z",
            "endDate": "2019-08-24T14:15:22.123Z",
            "name": "string",
            "cancelDate": "2019-08-24T14:15:22.123Z",
            "cancelDateOn": "2019-08-24T14:15:22.123Z",
            "cancelCreationDate": "2019-08-24T14:15:22.123Z",
            "membershipStatus": "string",
            "valueNextMonth": 0,
            "nextCharge": "2019-08-24T14:15:22.123Z",
            "nextDateSuspension": "2019-08-24T14:15:22.123Z",
            "idSale": 0,
            "saleDate": "2019-08-24T14:15:22.123Z",
            "contractPrinting": "string",
            "freezes": [
                {
                    "startSuspend": "2019-08-24T14:15:22.123Z",
                    "endSuspend": "2019-08-24T14:15:22.123Z",
                    "unlockDate": "2019-08-24T14:15:22.123Z",
                    "idEmployee": 0,
                    "reason": "string",
                    "flUseMembershipFreezeDays": true,
                    "daysFreeze": 0,
                    "idFreeze": 0
                }
            ],
            "idCategoryMembership": 0,
            "numberSuspensionTimes": 0,
            "maxSuspensionDays": 0,
            "minimumSuspensionDays": 0,
            "disponibleSuspensionDays": 0,
            "disponibleSuspensionTimes": 0,
            "daysLeftToFreeze": 0,
            "loyaltyEndDate": "2019-08-24T14:15:22.123Z",
            "assessmentEndDate": "2019-08-24T14:15:22.123Z",
            "acceptanceDate": "2019-08-24T14:15:22.123Z",
            "flAllowLocker": true,
            "flAdditionalMembership": true,
            "bioimpedanceAmount": 0,
            "signedTerms": true,
            "originalValue": 0,
            "allowLesMills": true,
            "allowsCancellationByApp": true
        }
    ],
    "lastAccessDate": "2019-08-24T14:15:22.123Z",
    "idEmployeeConsultant": 0,
    "nameEmployeeConsultant": "string",
    "idEmployeeInstructor": 0,
    "nameEmployeeInstructor": "string",
    "idEmployeePersonalTrainer": 0,
    "nameEmployeePersonalTrainer": "string",
    "photoUrl": "string",
    "idMemberMigration": "string",
    "responsibles": [
        {
            "idResponsible": 0,
            "idMember": 0,
            "name": "string",
            "email": "string",
            "phone": "string",
            "observation": "string",
            "idMemberResponsible": 0,
            "acessFiti": true,
            "financialResponsible": true
        }
    ],
    "tokenGympass": "string",
    "personalTrainer": true,
    "personalType": "string"
}

🟠400Bad Request

Get basic member information.

Get Basic Member Information#

Description#

🔑 Query Parameter#

📤 Response Structure#

🧩 contacts Object#

🧩 memberships Object#

🧩 memberships.freezes Object#

🧩 memberships.sessions Object#

🧩 responsibles Object#

Request