listar_empresas - Pipo Public API

Lista as empresas acessíveis à sua conta, preservando a hierarquia devolvida pela Pipo. As empresas no nível principal são matrizes. Dentro de cada matriz aparecem:

filiais: as subsidiárias da matriz;
PJs: empresas vinculadas ao contrato de serviço.

Cada empresa traz ID, nome, CNPJ, tipo de relação (matriz, filial ou PJ), a matriz à qual está ligada e os produtos dela (ID e nome).

Parâmetros

Parâmetro	Obrigatório	Descrição
`relacao`	Não	Filtra por tipo: `matriz`, `filial` ou `pj`.
`matriz`	Condicional	Matriz por nome, CNPJ ou UUID. O nome aceita parte do texto. Obrigatório ao filtrar por `filial` ou `pj`.
`produto`	Não	Nome do produto, por exemplo `Plano Essencial`. Aceita parte do nome.
`limite`	Não	Número de empresas na própria resposta, de 1 a 100.

Os filtros se combinam: a resposta traz as empresas que atendem a todos os filtros informados. A matriz de cada empresa sempre vem junto, para manter a hierarquia.

O filtro por produto procura o nome do produto na matriz, identifica o produto correspondente e devolve a matriz junto com as filiais e PJs que o possuem.

Sem limite, a ferramenta não coloca a lista na resposta. Ela devolve um link para a lista paginada, com ou sem filtros. O assistente lê as páginas, de 50 em 50 empresas. Se o seu cliente não lê esse link sozinho, ele usa ler_pagina_listagem. Com limite, a lista vem na própria resposta, mas é uma amostra: não é a lista completa.

Exemplos de perguntas

“Quais empresas eu tenho acesso na Pipo?”
“Quais são as filiais da Acme Inc.?”
“Quais PJs estão vinculadas a esta matriz?”
“Quais empresas têm o produto Plano Essencial?”