This API is part of a shared digital infrastructure developed by and for education regions (onderwijsregio’s) to track and support prospective teachers and other education professionals throughout their journey—from initial orientation to their start in education.

The core system is built on Airtable and functions as an Applicant Tracking System (ATS) and CRM for regional coordination, data sharing, and reporting. To integrate this infrastructure with regional websites and third-party applications, we provide an API layer that enables external systems to submit data in a structured and secure way.

This documentation is intended for developers building or maintaining integrations with the platform and describes the available endpoints, data models, and integration patterns.

Access and authentication

Access to the API is granted via an API key. For security and governance reasons, API keys are only issued to education regions that participate in the project. Once an API key is obtained, you are free to create as many additional keys as you like.

Requests

Learn how to obtain an initial API key and how to authenticate your requests to the API.

Discover your schema

Before creating or updating a candidate, you should retrieve the schema for your region using the /schema endpoint. This endpoint returns the authoritative, region-specific definition of all fields that are accepted in the candidate payload.

Schema

The schema provides a complete overview of the shared candidate data model and the region-specific custom fields that apply to your education region.

Mutation Engine

All mutation requests to our API are queued and processed by the mutation engine. The engine provides a reliable and predictable developer experience by serializing write operations and managing retries. This approach allows us to safely handle edge cases and work around some of Airtable’s quirks, without exposing that complexity to API consumers.

As a result, developers can issue mutation requests with confidence, knowing they will be executed consistently and in the correct order.

Mutation Engine

How our mutation engine works, and what to expect from it.