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, informe o parâmetro "with" com o(s) nome(s) da(s) relação(ões) separados por ";" (ponto-e-vírgula).

Por exemplo, se você deseja buscar a carteira e o produto vinculados à uma determinada filas de atendimento, a consulta deve ser feita desta forma:

http://{{subdominio}}.csm.pipe.run/api/v2/queues?with=card;card.product

No exemplo acima, pode-se notar que utilizamos 2 relacionamentos, card e card.product. No segundo valor foi utilizado em relacionamento composto, então nesse caso irá retornar os dados da carteira vinculada à fila de atendimento e também os dados do produto vinculado à carteira.
Nesta situação nem seria necessário informar o valor "card", pois ao informar o valor "card.product", a API retornaria o objeto "card" automaticamente.

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