Introduction

The ZFV API is a GraphQL API that provides access to the ZFV data. The API is secured with an API key.

The ZFV API is available on this URL: https://api.zfv.ch/graphql

Obtaining the API Key

Please contact ZFV team to obtain the API key.

Headers

All requests that fetch sensitive data need the API key in the api-key header.

To get the content in a specific language you need to set the locale header to the desired language. At the moment we support de, it, fr, en.

Testing the API with GraphiQL Playground

This documentation uses interactive playground that allows you to test the API manually.

In order to see schema introspection for exploring the API in the playground, you need to be authenticated.

Throughout the documentation you will see examples of queries and mutations that you can run in the playground. For example: