Entidades relacionadas em resultados

É possível trazer resultados e seus dados complementares em uma única requisição. Se a requisição que você deseja utilizar possui relações disponíveis, acrescente o nome da relação com os valores separados por vírgula logo após o parâmetro "with" em sua requisição.

Vejamos um exemplo: se você deseja buscar pessoas e oportunidades vinculadas à uma determinada empresa, a consulta deve ser feita desta forma:

https://api.pipe.run/v1/companies?with=persons,deals

Em alguns casos, relações padrão são trazidas automaticamente com os resultados, então você não precisa incluí-las novamente.

As relações disponíveis estão documentadas na descrição e complementos das requisições.