> ## Documentation Index
> Fetch the complete documentation index at: https://developers.mypilotindex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Build with MyPilotIndex

> Guides and a complete reference for logbooks and other aviation software that connect with a pilot who has chosen to share his data.

> [!WARNING]
>
> The MyPilotIndex Partner API is in preparation and is not live. Access is by request: use the [access request form](https://mypilotindex.com/api#request-access), and we will answer with a sandbox credential. Nothing here is available in production until we tell you so.

The Partner API lets an approved application, such as an electronic logbook, work with a pilot who has chosen to connect it. The pilot decides, on a MyPilotIndex consent screen, which parts of his data the partner may use.

## Start here

> [card] [Quickstart](https://developers.mypilotindex.com/quickstart.md)
>
> From an access request to your first call, in eight steps.

> [card] [Sandbox](https://developers.mypilotindex.com/sandbox.md)
>
> Ten synthetic pilots on the dev environment, never real members.

> [card] [Authentication](https://developers.mypilotindex.com/authentication.md)
>
> OAuth 2.0 client credentials and the scopes a token carries.

> [card] [Consent and sign in](https://developers.mypilotindex.com/consent.md)
>
> Send the pilot to the consent screen and exchange the code for a grant.

## What a partner can do

| Operation | Route | What it does |
| - | - | - |
| Exchange a code | `POST /v1/partner/grants/exchange` | Opens a grant after the pilot allows you on the consent screen. |
| List grants | `GET /v1/partner/grants` | Lists your grants, and the ones revoked since a time you name. |
| Read a pilot summary | `GET /v1/partner/grants/{grant_id}/summary` | Profile, score, hours and licenses, for the blocks the grant allows. |
| Push flight totals | `PUT /v1/partner/grants/{grant_id}/flight-totals` | A whole-state push of a logbook's totals, safe to retry by `as_of`. |
| Check a certificate | `GET /v1/partner/certificates/{certificate_id}` | Checks an MPI Report by its public id. |
| Test your webhook | `POST /v1/partner/webhooks/test` | Queues one signed `ping` to your webhook URL. |

> [card] [API reference](https://developers.mypilotindex.com/api-reference/introduction.md)
>
> Every operation, its parameters, its answers and examples, with a playground.

## What is never shared

The Partner API never carries a pilot's e-mail, phone, address, date of birth, certificate numbers, documents, background answers, salary, messages or recruiter signals, and his pairwise id, not his account id, is what names him to you. A block of data the grant does not hold is absent from the answer.

## Read these docs with an AI assistant

Every page has a Markdown version at its URL plus `.md`, and `/llms.txt` lists them all. Use the menu at the top of each page to copy it as Markdown or open it in ChatGPT or Claude.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.