Grants

Read the active jobs that fit the pilot best

The jobs that fit the pilot of a grant that holds jobs.match, drawn from the newest 50 active listings and ordered by the match, highest first, then by the newest. Each job carries the match as the pilot’s own plan presents it, so a partner reads for a free pilot what he reads himself: the headline, with detail plan_required, and the breakdown and the missing requirements only for a paying pilot. match is null for a posting the engine does not score, such as a job for mechanics, and those come after the scored ones. A grant that is revoked, unknown or another partner’s answers 404 not_found; a grant, or a token, without jobs.match is 403 scope_missing.

GET

partner

grants

{grant_id}

job-matches

Read the active jobs that fit the pilot best

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

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

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

import requests

url = "https://{devApiHost}/v1/partner/grants/{grant_id}/job-matches"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "logo_url": "<string>"
      },
      "position_type": "captain",
      "employment_type": "full_time",
      "operation_type": "part_121",
      "base_location": "<string>",
      "base_airport_code": "<string>",
      "min_total_hours": 123,
      "min_pic_hours": 123,
      "min_multi_engine_hours": 123,
      "min_turbine_hours": 123,
      "min_jet_hours": 123,
      "required_licenses": [
        "<string>"
      ],
      "required_type_ratings": [
        "<string>"
      ],
      "salary_min": 123,
      "salary_max": 123,
      "salary_type": "annual",
      "salary_currency": "<string>",
      "posted_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "match": {
        "overall": 123,
        "matchLabel": "strong_match",
        "engine_version": "<string>",
        "detail": "plan_required",
        "breakdown": {},
        "missingRequirements": [
          "<string>"
        ]
      }
    }
  ]
}

{
  "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": "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

Query Parameters

limit

integer

default:10

Required range: 1 <= x <= 20

Response

The jobs, the best first.

items

object[]

required

Maximum array length: 20

Show child attributes

⌘I

Read the active jobs that fit the pilot best

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

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

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

import requests

url = "https://{devApiHost}/v1/partner/grants/{grant_id}/job-matches"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "logo_url": "<string>"
      },
      "position_type": "captain",
      "employment_type": "full_time",
      "operation_type": "part_121",
      "base_location": "<string>",
      "base_airport_code": "<string>",
      "min_total_hours": 123,
      "min_pic_hours": 123,
      "min_multi_engine_hours": 123,
      "min_turbine_hours": 123,
      "min_jet_hours": 123,
      "required_licenses": [
        "<string>"
      ],
      "required_type_ratings": [
        "<string>"
      ],
      "salary_min": 123,
      "salary_max": 123,
      "salary_type": "annual",
      "salary_currency": "<string>",
      "posted_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "match": {
        "overall": 123,
        "matchLabel": "strong_match",
        "engine_version": "<string>",
        "detail": "plan_required",
        "breakdown": {},
        "missingRequirements": [
          "<string>"
        ]
      }
    }
  ]
}

{
  "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": "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

Jobs

Publishing

Insights

Certificates

Webhooks

Read the active jobs that fit the pilot best

Authorizations

Path Parameters

Query Parameters

Response