Relações em Respostas

Relações em Respostas (with)

É possível obter registros e seus dados complementares em uma única requisição utilizando o parâmetro with. Se o endpoint da API disponibilizar relações associadas (por exemplo, pessoas relacionadas a uma empresa), basta informar o(s) nome(s) da(s) relação(ões) desejada(s) após o parâmetro with, separados por vírgula caso queira múltiplas relações.

Exemplo de utilização

Se você deseja buscar empresas e, ao mesmo tempo, retornar as pessoas vinculadas a cada empresa, utilize o parâmetro with como no exemplo abaixo:

GET https://api.pipe.run/v1/companies?with=personsRelated&cursor=

⚠️

Observação: Algumas relações padrão já podem ser retornadas automaticamente em determinadas requisições, portanto, não é necessário incluí-las novamente no parâmetro with.

As relações disponíveis para cada endpoint estão descritas na especificação de referência.

Exemplo de resposta

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 1234567890,
      "name": "Empresa XPTO",
       // ... outros campos
      "personsRelated": [
        {
          "account_id": 123456789,
          "person_id": 123456789,
          "company_id": 123456789,
          "is_main_company": true,
          "job_title": "49-Sócio-Administrador",
          "started_working_at": null,
          "created_at": "2025-07-08 17:03:22",
          "updated_at": "2025-07-08 17:03:22"
        }
        // ... outros registros
      ]
    }
  ],
  "meta": {
    "cursor": {
      "current": null,
      "prev": null,
      "next": "eyJpZCI6MTk3Njk0NTksIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
      "count": null
    }
  }
}