Obtener Miembros Activos

Descripción

Recupera la lista de miembros activos de la empresa, pudiendo devolver los datos de una sucursal específica o de todas las sucursales, según el contexto del token de autenticación utilizado.

🔑 Parámetros de Consulta (Query Params)

Este endpoint no posee parámetros obligatorios. En entornos con múltiples sucursales, se recomienda informar idBranch para limitar el alcance de la consulta.

Parámetro	Tipo	Obligatorio	Descripción
idBranch	int32	No	ID de la sucursal. Cuando se proporciona, devuelve solo miembros activos de la sucursal especificada. Cuando no se proporciona, y el token posee acceso multi-sucursal, devuelve miembros activos de todas las sucursales.

📤 Estructura de la Respuesta

🚧 La respuesta de este endpoint está en XML. No se recibirá un JSON convencional.

Cada ítem representa un miembro activo con información de vínculo, contrato y período de vigencia.

Campo	Tipo	Descripción
`idBranch`	entero	Identificador de la sucursal a la que pertenece el miembro.
`branchName`	string	Nombre de la sucursal.
`memberName`	string	Nombre completo del miembro (cliente).
`document`	string	CPF del miembro.
`idMember`	entero	Identificador único del miembro.
`contractDescription`	string	Descripción del contrato o plan asociado al miembro.
`contractType`	string	Tipo de contrato del miembro.
`idContractType`	entero	Identificador del tipo de contrato.
`startDate`	datetime	Fecha de inicio de vigencia del contrato.
`endDate`	datetime	Fecha de fin de vigencia del contrato.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "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

Obtener Miembros Activos#

Descripción#

🔑 Parámetros de Consulta (Query Params)#