> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/products/registry/registry/developer-zone/api-documentation.md).

# API Documentation

API reference for OpenG2P Registry.

{% hint style="info" %}
**New home: GitLab.** **`registry-platform`** is now developed at [github.com/OpenG2P/registry-platform](https://github.com/OpenG2P/registry-platform).
{% endhint %}

OpenG2P Registry exposes two primary API surfaces. Both pages below are **generated from the OpenAPI specs published by** [**`registry-platform`**](https://github.com/OpenG2P/registry-platform/tree/develop/apis/docs/openapi) and render live from them, so the request/response schemas are always the spec's own.

## Staff Portal API

REST APIs consumed by the Registry Staff Portal UI for registry configuration, record management, change requests, intake forms, and search.

{% content-ref url="/pages/J1ZwdU1jAo8fXOKya7Kr" %}
[Staff Portal API](/products/registry/registry/developer-zone/api-documentation/staff-portal-api.md)
{% endcontent-ref %}

## Partner API

REST APIs for external system integration, including data ingestion and DCI-compliant search. The partner API is the policy-enforcement point for consent-aware data sharing — see [Partner APIs](/products/registry/registry/design/partner-apis.md).

{% content-ref url="/pages/DMI7dXZtCjw5Hr9DsZlE" %}
[Partner API](/products/registry/registry/developer-zone/api-documentation/partner-api.md)
{% endcontent-ref %}

## How these pages are maintained

Each endpoint needs one GitBook `openapi-operation` block. Hand-typing them is how the reference silently fell to 96 of 174 endpoints, so the block list is now generated:

```bash
bash tools/gen-openapi-pages.sh
```

Run that after adding or removing routes; it re-emits every operation from the spec, so the page cannot be short.

{% hint style="info" %}
**There is one version of this reference, tracking `develop`.** Per-release snapshots were removed because they were not snapshots: the committed OpenAPI spec is currently byte-identical at `develop`, `1.1.0` and `v1.0.0`, so all three rendered the same 174 endpoints.

Frozen per-release references become meaningful once `apis/scripts/generate_openapi.py` runs in CI so the spec is regenerated with each release. At that point a snapshot is one line in the generator script.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.openg2p.org/products/registry/registry/developer-zone/api-documentation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.