API reference

This page is the launchpad for every public API surface of the GEO Knowledge Hub. Each card below opens a dedicated Scalar page that renders the OpenAPI specification with full search, request examples and language-specific code samples.

Documentation rationale

The interactive references are the canonical place to discover what each endpoint accepts and returns. For how the endpoints fit together, like the combined use of drafts, files, publishing, and versioning, see the examples.

For a curated list of the most-used endpoints with deep links into each spec, see common endpoints.

Available APIs

Records v1.0.0

Records API

Knowledge Packages and Knowledge Resources. Cover operations of drafts, files, versions, package-resource associations, access links and unified search.

Knowledge Packages, Resources & search Open spec

Events v1.0.0

Events API

Training sessions, workshops, webinars and other community events surfaced on the GEO Knowledge Hub.

Community events feed Open spec

Metrics v1.0.0

Metrics API

Aggregated KPIs, contribution timeline, organisation types, visitors, webinars, roles and beneficiary quotes — the same payload that powers the public stats report.

Stats report payload Open spec

Vocabularies v1.0.0

Vocabularies API

Controlled vocabularies, including affiliations, names, funders, awards, subjects, engagement priorities, target audiences and GEO Work Programme activities.

Controlled vocabularies Open spec

InvenioRDM endpoints

Endpoints inherited unchanged from InvenioRDM (Communities, Groups, Members, notifications, …) follow the upstream contract. Please consult the InvenioRDM REST API documentation for those.