v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Colaboradores

Listar colaboradores

Retorna lista paginada de colaboradores das empresas informadas com filtros opcionais. Paginação por cursor: use o valor de _links.next.href para navegar entre páginas.

Status do colaborador:

StatusSignificado
activeColaborador ativo com conta BTG
pendingOnboarding em andamento, conta ainda não ativada
suspendedConta suspensa
inactiveColaborador desligado
get/{companyId}/banking/payroll/employees

Path parameters

companyIdstring required

Query parameters

companyTaxIdsstring[]
pageSizeinteger
cursorstring
statusstring
accountTypestring
namestring
employeeTaxIdstring
branchstring
accountNumberstring
portabilityboolean
contractTypestring

Response

OK