Welcome to Common Ground API Client’s documentation!

The Common Ground API Client is a generic client for Common Ground API’s built with OpenAPI 3.0 specifications.

Build status Coverage status Documentation Status pypi-version

Code quality checks black python-versions


  • Driven by OAS 3.0 specification

  • (Pluggable) caching of api specifications

  • Create/mutate resources according to the api specifications

  • Support for multiple authentication schemes

    • ZGW auth (JWT based)

    • API-key via HTTP headers

    • or none, for open APIs

  • Generic approach, but very well suited for the “API’s voor zaakgericht werken” standard

  • Built on top of battle-proven requests library.

Indices and tables