Expandindo referências

Muitos objetos permitem que você solicite informações adicionais com uma resposta expandida usando o parâmetro expand. Esse parâmetro está disponível em todas as solicitações de API e se aplica apenas à resposta dessa solicitação. As respostas podem ser expandidas de duas maneiras.

Em muitos casos, um objeto contém o ID de um objeto relacionado em suas propriedades de resposta. Por exemplo, um Loan pode ter um ID de Customer associado. Esses objetos podem ser expandidos com o parâmetro da requisição expand. Todos os campos que possuem um ID podem ser expandidos.

GET https://api.base39.io/loans/loan_63ff94f928a4fb05d70b7a17?expand=customer,employment

{
  "id": loan_63ff94f928a4fb05d70b7a17,
  "customer": {
    "id": "cust_63ff98c128a4fb05d70b7a22",
    "name": "João",
    "username": "joao",
    ...
  },
  "employment": {
    "id": "empl_63ff98cf28a4fb05d70b7a25",
    "grossSalary": 5000,
    "netSalary": 4000,
    ...
  }
  ...
}

Você pode expandir recursivamente especificando campos após um ponto (.). Por exemplo, solicitar loan.customer em um Loan expandirá a propriedade loan em um objeto de Loan completo e, em seguida, expandirá a propriedade customer nessa fatura em um objeto Customer completo.

GET https://api.base39.io/v1/loans?expand=data.customer

{
  "hasMore": true,
  "data": [
    {
      "id": loan_63ff94f928a4fb05d70b7a17,
      "customer": {
        "id": "cust_63ff98c128a4fb05d70b7a22",
        "name": "João",
        "username": "joao",
        ...
      },
      "employment": {
        "id": "empl_63ff98cf28a4fb05d70b7a25",
        "grossSalary": 5000,
        "netSalary": 4000,
        ...
      }
      ...
    },
    ...
  ]
}