OpenAPI specification

OpenAPI specification

The /partner/v1 plane is defined by an OpenAPI 3.0 document — the same file the Geena backend generates its routing from, so the published contract cannot drift from the implementation.

Download partner-v1.yaml

curl -sO https://docs.test.geena.eu/openapi/partner-v1.yaml

The Organization API has its own document, org-v1.yaml, built the same way.

Use them to generate typed clients in your stack (openapi-generator, oapi-codegen, openapi-typescript, …) or to import the collections into an API tool. Three conventions worth knowing when reading them:

  • Path ids are documented as UUIDs, but the server deliberately answers malformed ids with the same 404 not_found as foreign ones — do not rely on a 400 for client-side id validation.
  • The participant query parameter is read by name; a generated client must send it as participant, exactly as spelled, on subject-bearing slots.
  • The OAuth endpoints (/oauth/authorize, /oauth/token, /oauth/revoke) are not part of either document; they are covered in Connect with Geena.