Relationships - Leadfeeder API

Some endpoints in the Leadfeeder API have the capability to return related objects.

For example, when fetching a Contact via the Get Contact Details endpoint, part of the response will be a relationships object, which will contain a company key, which in turn will contain an object with only the following keys:

id: the ID of the related object

type: the type of the related object (in the above example, it would be "company")

You can then use the Get Company Details endpoint to fetch the details of that particular company using the id returned above.

Additionally, some endpoints support fetching related objects in a single request. As the Get Contact Details endpoint is one such endpoint, we can use it as an example.

To fetch the related data, we add the include parameter to the query string as follows: include=<relationship names separated by commas>. In this example, we would add include=company. Note that you can specify multiple relationships this way.

The response would then include the entire Company object under the Contact's relationship key.

Note that the feature is only supported by endpoints that explicitly mention it in theit documentation, and we only support fetching immediate relationships (i.e. there is currently no way to fetch relationships that are more than one level deep).