Search Prospects

Description

Endpoint to query prospects with various filters and pagination.

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

🔑 Query Parameters

Parameter	Type	Required	Description
idProspect	int32	No	ID of the prospect
name	string	No	Name of the prospect
document	string	No	Document of the prospect
email	string	No	Email of the prospect
phone	string	No	Phone/cell number of the prospect
registerDateStart	date-time	No	Start date for registration filter
registerDateEnd	date-time	No	End date for registration filter
conversionDateStart	date-time	No	Start date for conversion date filter
conversionDateEnd	date-time	No	End date for conversion date filter
take	int32	No	Total records to return (maximum 50). Default: 50
skip	int32	No	Total records to skip (offset). Default: 0
gympassId	string	No	Gympass ID of the prospect

📤 Response Structure

The response returns a list of registered prospects, containing personal information, contact data, registration source, conversion status, interests, and financial responsible parties.

Field	Type	Description
`idProspect`	int32	Unique identifier of the prospect.
`idBranch`	int32	ID of the branch where the prospect was registered.
`branchName`	string	Name of the branch associated with the prospect.
`firstName`	string	First name of the prospect.
`lastName`	string	Last name of the prospect.
`registerName`	string	Name provided at the time of registration.
`registerLastName`	string	Last name provided at the time of registration.
`usePreferredName`	boolean	Indicates if the prospect uses a preferred name.
`document`	string	Main document of the prospect (e.g., CPF).
`rg`	string	General Registry (RG) of the prospect.
`cellphone`	string	Cell phone number.
`email`	string	Email address of the prospect.
`gympassId`	string	Identifier of the prospect in partner platforms (e.g., Gympass).
`registerDate`	date-time	Registration date of the prospect.
`gender`	string	Gender provided by the prospect.
`birthDate`	date-time	Birth date of the prospect.
`signupType`	string	Type of registration performed (e.g., in-person, online, campaign).
`mktChannel`	string	Marketing channel of the prospect's origin.
`conversionDate`	date-time	Conversion date of the prospect to member, if applicable.
`idMember`	int32	ID of the member associated after conversion.
`currentStep`	string	Current step in the relationship/commercial funnel.
`address`	string	Address of the prospect.
`city`	string	City of the address.
`complement`	string	Address complement.
`neighborhood`	string	Neighborhood of the address.
`state`	string	State of the address.
`country`	string	Country of the address.
`zipCode`	string	ZIP code.
`number`	string	Address number.
`temperature`	string	Interest classification of the prospect (e.g., cold, warm, hot).
`notes`	string	Additional notes about the prospect.
`interests`	array	List of interests provided by the prospect.
`financiallyResponsibles`	array	Financially responsible parties associated with the prospect. See more below.

🧩 Structure of `financiallyResponsibles`

Field	Type	Description
`idMember`	int32	Identifier of the financially responsible member.
`name`	string	Name of the financially responsible party.
`email`	string	Email of the financially responsible party.
`cpf`	string	CPF of the financially responsible party.

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

[
    {
        "idProspect": 0,
        "idBranch": 0,
        "branchName": "string",
        "firstName": "string",
        "lastName": "string",
        "registerName": "string",
        "registerLastName": "string",
        "usePreferredName": true,
        "document": "string",
        "rg": "string",
        "cellphone": "string",
        "email": "string",
        "gympassId": "string",
        "registerDate": "2019-08-24T14:15:22.123Z",
        "gender": "string",
        "birthDate": "2019-08-24T14:15:22.123Z",
        "signupType": "string",
        "mktChannel": "string",
        "conversionDate": "2019-08-24T14:15:22.123Z",
        "idMember": 0,
        "currentStep": "string",
        "address": "string",
        "city": "string",
        "complement": "string",
        "neighborhood": "string",
        "state": "string",
        "country": "string",
        "zipCode": "string",
        "number": "string",
        "temperature": "string",
        "notes": "string",
        "interests": [
            "string"
        ],
        "financiallyResponsibles": [
            {
                "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"
            }
        ]
    }
]

🟠400Bad Request

Get prospects