Obter Membros Ativos

Descrição

Recupera a lista de membros ativos da empresa, podendo retornar os dados de uma filial específica ou de todas as filiais, conforme o contexto do token de autenticação utilizado.

🔑 Parâmetros de Consulta (Query Params)

Este endpoint não possui parâmetros obrigatórios. Em ambientes com múltiplas filiais, é recomendado informar o idBranch para limitar o escopo da consulta.

Parâmetro	Tipo	Obrigatório	Descrição
idBranch	int32	Não	ID da filial. Quando informado, retorna apenas membros ativos da filial especificada. Quando não informado, e o token possuir acesso multi-filial, retorna membros ativos de todas as filiais.

📤 Estrutura da Resposta

🚧 O retorno desse endpoint é em XML. Ou seja, você não receberá um json comum.

Cada item representa um membro ativo com informações de vínculo, contrato e período de vigência.

Campo	Tipo	Descrição
`idBranch`	inteiro	Identificador da filial à qual o membro está vinculado.
`branchName`	string	Nome da filial.
`memberName`	string	Nome completo do membro (cliente).
`document`	string	CPF do membro.
`idMember`	inteiro	Identificador único do membro.
`contractDescription`	string	Descrição do contrato ou plano associado ao membro.
`contractType`	string	Tipo do contrato do membro.
`idContractType`	inteiro	Identificador do tipo de contrato.
`startDate`	datetime	Data de início da vigência do contrato.
`endDate`	datetime	Data de término da vigência do 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

Obter Membros Ativos#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#