Get Members

Description

Returns a list of members. Used to access information related to the gym's students, allowing various filters by name, document, registration dates, status, among others.

🚧 NOTE: For the status field to be returned correctly, it is necessary to set showMemberships = true.
Available for use with branch access key and also with General ADM access key.

🔑 Query Parameters (Query Params)

Parameter	Type	Required	Description
name	string	No	Filters members by name.
email	string	No	Filters members by email.
document	string	No	Filters members by document number.
phone	string	No	Filters members by phone or mobile. E.g.: 1112341234
conversionDateStart	date-time	No	Filters members by initial conversion date. (Format: yyyy-mm-dd)
conversionDateEnd	date-time	No	Filters members by final conversion date. (Format: yyyy-mm-dd)
registerDateStart	date-time	No	Filters members by initial registration date. (Format: yyyy-mm-dd)
registerDateEnd	date-time	No	Filters members by final registration date. (Format: yyyy-mm-dd)
membershipStartDateStart	date-time	No	Filters members by membership start date. (Format: yyyy-mm-dd)
membershipStartDateEnd	date-time	No	Filters members by membership start date. (Format: yyyy-mm-dd)
membershipCancelDateStart	date-time	No	Filters members by membership cancellation date. (Format: yyyy-mm-dd)
membershipCancelDateEnd	date-time	No	Filters members by membership cancellation date. (Format: yyyy-mm-dd)
status	int32	No	Filters members by status: 1 - Active (includes Suspended and VIPs), 2 - Inactive
tokenGympass	string	No	Filters by the member's token in Gympass.
take	int32	No	Defines the total number of records to return. The default value is 50. Maximum of 50.
skip	int32	No	Defines the number of records to skip. The default value is 0.
idsMembers	string	No	Filters by member IDs. Add member IDs separated by commas (E.g.: 1,2,3)
onlyPersonal	boolean	No	Defines whether to show only personal trainers. The default value is `false`.
personalType	int32	No	Filters by personal trainer type: 1 - Internal, 2 - External
showActivityData	boolean	No	Defines whether to display activity data of members. The default value is `false`.
idBranch	int32	No	Filters by the ID of the member's branch. (Available only when using a multilocation key)
updateDate	date-time	No	Filters members with update data greater than or equal to the provided date. (Format: yyyy-mm-dd)
showMemberships	boolean	No	Defines whether to display membership data of members. The default value is `false`.
showsResponsibles	boolean	No	Defines whether to show the data of the guardians of the member. The default value is `false`.
membershipEndDateStart	string	No	Filters members by the initial end date of the membership. (Format: yyyy-mm-dd)
membershipEndDateEnd	string	No	Filters members by the final end date of the membership. (Format: yyyy-mm-dd)
registerName	string	No	Filters members by registration name.
whatsappUsername	string	No	Filter by WhatsApp username associated with the member.
whatsappBsuid	string	No	Filter by WhatsApp BSUID identifier associated with the member.

🔷 `status` Enum

Code	Description
1	Active Member (includes suspended and VIPs)
2	Inactive Member

🔷 `personalType` Enum

Description	Code
Internal	1
External	2

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",
    "document": "string",
    "documentId": "string",
    "maritalStatus": "string",
    "gender": "string",
    "birthDate": "2019-08-24T14:15:22.123Z",
    "updateDate": "2019-08-24T14:15:22.123Z",
    "address": "string",
    "state": "string",
    "city": "string",
    "zipCode": "string",
    "complement": "string",
    "neighborhood": "string",
    "accessCardNumber": "string",
    "number": "string",
    "totalFitCoins": 0,
    "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",
    "conversionDate": "2019-08-24T14:15:22.123Z",
    "idEmployeeConsultant": 0,
    "nameEmployeeConsultant": "string",
    "idEmployeeInstructor": 0,
    "nameEmployeeInstructor": "string",
    "idEmployeePersonalTrainer": 0,
    "nameEmployeePersonalTrainer": "string",
    "idMemberPersonalTrainer": 0,
    "nameMemberPersonalTrainer": "string",
    "photoUrl": "string",
    "country": "string",
    "idMemberMigration": "string",
    "responsibles": [
        {
            "idResponsible": 0,
            "idMember": 0,
            "name": "string",
            "cpf": "string",
            "email": "string",
            "phone": "string",
            "observation": "string",
            "idMemberResponsible": 0,
            "acessFiti": true,
            "financialResponsible": true,
            "personType": "string",
            "document": "string",
            "cep": "string",
            "adress": "string",
            "number": "string",
            "complement": "string",
            "district": "string",
            "city": "string",
            "state": "string",
            "idResponsibleCategory": 0,
            "responsibleCategoryName": "string",
            "responsibleValidated": true,
            "darwinBilling": true,
            "updateDate": "2019-08-24T14:15:22.123Z",
            "idEmployeeUpdate": 0
        }
    ],
    "gympassId": "string",
    "whatsappUsername": "string",
    "whatsappBsuid": "string",
    "personalTrainer": true,
    "personalType": "string",
    "cref": "string",
    "crefExpirationDate": "2019-08-24T14:15:22.123Z",
    "codeTotalpass": "string",
    "userIdGurupass": "string",
    "clientWithPromotionalRestriction": true
}

🟠400Bad Request

Get members

Get Members#

Description#

🔑 Query Parameters (Query Params)#

🔷 status Enum#

🔷 personalType Enum#