Grants

Read the pilot summary

The blocks of the pilot data that his grant allows, and only those: profile (name, username, avatar_url), score (the exact stored MPI Score with one decimal, its phase and when it was computed; exact even if the pilot hides his score publicly, because he agreed to it on the consent screen), hours (hours.read: flight, helicopter and simulator figures in separate blocks so simulator time is never added to flight time; columns at zero are omitted; one decimal) and licenses (licenses with their class ratings, and type ratings). A block the grant lacks is absent. The grant must hold at least one of profile, score, hours.read and licenses, and the partner token must still carry it, otherwise 403 forbidden with reason scope_missing. The answer names the pilot by his pairwise id and never carries e-mail, phone, address, date of birth, certificate numbers, documents, background answers, salary, messages or recruiter signals. A grant that is revoked, unknown or another partner grant answers 404 not_found.

GET

partner

grants

{grant_id}

summary

Read the pilot summary

curl --request GET \
  --url https://{devApiHost}/v1/partner/grants/{grant_id}/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{devApiHost}/v1/partner/grants/{grant_id}/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "pilot_id": "2d9b7c1e-8f4a-4e3b-a6d5-91c0f2e7b844",
  "profile": {
    "name": "Ana Souza",
    "username": "anasouza",
    "avatar_url": "https://cdn.mypilotindex.com/avatars/2d9b.jpg"
  },
  "score": {
    "value": 512.4,
    "phase": "positioning",
    "computed_at": "2026-11-03T21:14:09Z"
  },
  "hours": {
    "flight": {
      "total_hours": 1530.2,
      "pic_hours": 640,
      "night_hours": 210.5
    },
    "helicopter": {
      "helicopter_total_hours": 85
    },
    "simulator": {
      "simulator_hours": 120,
      "simulator_ffs_hours": 80
    }
  },
  "licenses": {
    "licenses": [
      {
        "authority": "FAA",
        "type": "CPL",
        "category": "airplane",
        "status": "completed",
        "classes": [
          {
            "class": "AMEL",
            "status": "completed"
          }
        ]
      }
    ],
    "type_ratings": [
      {
        "designator": "B738",
        "name": "Boeing 737 NG",
        "current": true
      }
    ]
  },
  "as_of": "2026-11-04T12:00:00Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "scope_missing"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "rate_limited"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client credentials. Request a token from the token endpoint of the identity provider's domain (https://{cognito-domain}/oauth2/token, with HTTP Basic client authentication) and send it as a Bearer token. Production uses auth.mypilotindex.com. The sandbox uses the dev environment's Cognito domain, which is given to the partner with its sandbox credential. A token carries only the scopes the partner was approved for.

Path Parameters

grant_id

string<uuid>

required

Response

The granted blocks.

Only the blocks the grant holds the scope for appear.

pilot_id

string<uuid>

required

The pilot pairwise id at this partner.

as_of

string<date-time>

required

When the summary was read.

profile

object

Show child attributes

score

object

Show child attributes

hours

object

Columns at zero are omitted, and so is a block with none left. One decimal.

Show child attributes

licenses

object

Show child attributes

⌘I

Read the pilot summary

curl --request GET \
  --url https://{devApiHost}/v1/partner/grants/{grant_id}/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{devApiHost}/v1/partner/grants/{grant_id}/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "pilot_id": "2d9b7c1e-8f4a-4e3b-a6d5-91c0f2e7b844",
  "profile": {
    "name": "Ana Souza",
    "username": "anasouza",
    "avatar_url": "https://cdn.mypilotindex.com/avatars/2d9b.jpg"
  },
  "score": {
    "value": 512.4,
    "phase": "positioning",
    "computed_at": "2026-11-03T21:14:09Z"
  },
  "hours": {
    "flight": {
      "total_hours": 1530.2,
      "pic_hours": 640,
      "night_hours": 210.5
    },
    "helicopter": {
      "helicopter_total_hours": 85
    },
    "simulator": {
      "simulator_hours": 120,
      "simulator_ffs_hours": 80
    }
  },
  "licenses": {
    "licenses": [
      {
        "authority": "FAA",
        "type": "CPL",
        "category": "airplane",
        "status": "completed",
        "classes": [
          {
            "class": "AMEL",
            "status": "completed"
          }
        ]
      }
    ],
    "type_ratings": [
      {
        "designator": "B738",
        "name": "Boeing 737 NG",
        "current": true
      }
    ]
  },
  "as_of": "2026-11-04T12:00:00Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "scope_missing"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "rate_limited"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

Overview

Grants

Certificates

Webhooks

Read the pilot summary

Authorizations

Path Parameters

Response