Get Active Members

Description

Retrieves the list of active members of the company, which can return data from a specific branch or from all branches, depending on the context of the authentication token used.

🔑 Query Parameters (Query Params)

This endpoint does not have mandatory parameters. In environments with multiple branches, it is recommended to provide the idBranch to limit the scope of the query.

Parameter	Type	Required	Description
idBranch	int32	No	ID of the branch. When provided, returns only active members from the specified branch. When not provided, and the token has multi-branch access, returns active members from all branches.

📤 Response Structure

🚧 The response from this endpoint is in XML. That is, you will not receive a common json.

Each item represents an active member with information about affiliation, contract, and validity period.

Field	Type	Description
`idBranch`	integer	Identifier of the branch to which the member is affiliated.
`branchName`	string	Name of the branch.
`memberName`	string	Full name of the member (customer).
`document`	string	CPF of the member.
`idMember`	integer	Unique identifier of the member.
`contractDescription`	string	Description of the contract or plan associated with the member.
`contractType`	string	Type of the member's contract.
`idContractType`	integer	Identifier of the contract type.
`startDate`	datetime	Start date of the contract's validity.
`endDate`	datetime	End date of the contract's validity.

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

[
    {
        "idBranch": 0,
        "branchName": "string",
        "memberName": "string",
        "document": "string",
        "idMember": 0,
        "contractDescription": "string",
        "contractType": "string",
        "idContractType": 0,
        "startDate": "2019-08-24T14:15:22.123Z",
        "endDate": "2019-08-24T14:15:22.123Z"
    }
]

🟠400Bad Request

Retrieves active members from a specific branch or from all branches

Get Active Members#

Description#

🔑 Query Parameters (Query Params)#