Listar empresas do portfólio

GET 
/v1/portfolio/companies

Retorna todas as empresas que concederam a este conector uma conexão ativa e atualmente possuem o plano qualificador em sua assinatura principal. Requer um Connector Token (sem company_id).

A associação ao plano é resolvida a partir da fonte da verdade no momento da leitura, então uma empresa que perdeu o plano deixa de ser listada sem nenhuma ação sua. Uma empresa que cancelou sua renovação continua sendo listada até o fim do período que já pagou. meta.as_of informa a atualidade desses dados.

Escopo necessário: portfolio:read

Request

Responses

200

Empresas no portfólio do conector.

401

Não autenticado — a requisição não possui uma credencial, ou o token Bearer / API key é inválido, expirou ou foi revogado.

403

Escopo insuficiente — a credencial está autenticada, mas não possui um escopo exigido pelo endpoint.

404

Não encontrado — nenhum recurso corresponde ao id no caminho (ou ele pertence a outra empresa).

422

Falha de validação — o corpo da requisição falhou na validação do schema. errors[] lista todos os campos com problema.