Skip to main content
GET
Listar todos os membros

Authorizations

Authorization
string
header
required

Token Bearer obtido em POST /v1/authenticate.

Query Parameters

include-inactives
boolean
default:false

Quando true, inclui membros/benefícios inativos.

filters
string

Filtro no formato <campo>=<valor>, múltiplos filtros concatenados pelo caracter | (lógica OR).

Campos válidos: tax-id (CPF do membro), cost-center (Centro de Custo), employee-id (Matrícula funcional).

Exemplos:

  • Membros do Centro de Custo "Tech-123": cost-center=Tech-123
  • Membros do Centro de Custo "Tech-123" junto dos membros com as matrículas informadas: cost-center=Tech-123|employee-id=123|employee-id=456
  • Membros com CPF 12345678909 e 98765432100: tax-id=12345678909|tax-id=98765432100

Response

200 - application/json

Lista de membros.

result
object[]