Including related resources

Some of the endpoints that return a list of API resources support including related resources. Please visit the API reference to get this information for a specific endpoint under the include query param.

Including related resources can be performed using the include query param, e.g.:

curl --request GET \
--url 'https://api.northpass.com/v2/people?include=school' \
--header 'Accept: application/json' \
--header 'X-Api-Key: <INSERT_API_KEY_HERE>'

The example above will return the list of people and the associated schools. The associated resources are returned under the included key.

The API allows specifying multiple related resources, separated by a comma:

curl --request GET \
--url 'https://api.northpass.com/v2/people?include=school,partnerships' \
--header 'Accept: application/json' \
--header 'X-Api-Key: <INSERT_API_KEY_HERE>'

In the example above, the list will include both schools and partnerships related to the returned people.

For more information about including associated resources please visit the JSON API reference.


Did this page help you?