Jobs

Publish a job for the partner's company

Publishes a job for the company MyPilotIndex bound the partner to. The company comes from the binding, never from the body: company_id, source, featured, recruiter_id, created_by and every other member outside the schema are 400 invalid_request. status is active, unless the body says draft, which nobody reads until a change makes it active. A value the catalog does not hold, such as an unknown position_type, is 400 invalid_request, and nothing is published. 201 for a new job; 200 with replayed true for a retry of the same client_ref and body, which publishes nothing. See the Jobs tag for the client_ref and the allowance of 50 jobs per partner per rolling 24 hours. The token must carry jobs.write, otherwise 403 scope_missing.

POST

partner

jobs

curl --request POST \
  --url https://{devApiHost}/v1/partner/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_ref": "requisition-20261107-07",
  "title": "Captain, Citation Latitude",
  "description": "Part 135 operation out of Cleveland. Type rating provided.",
  "position_type": "captain",
  "employment_type": "full_time",
  "operation_type": "part_135",
  "base_location": "Cleveland, OH",
  "base_airport_code": "KCLE",
  "work_mode": "onsite",
  "min_total_hours": 3000,
  "min_jet_hours": 500,
  "required_licenses": [
    "ATP"
  ],
  "salary_min": 145000,
  "salary_max": 180000,
  "salary_type": "annual",
  "salary_currency": "USD",
  "application_url": "https://careers.example.com/jobs/7",
  "expires_at": "2026-12-07T12:00:00Z"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_ref: 'requisition-20261107-07',
    title: 'Captain, Citation Latitude',
    description: 'Part 135 operation out of Cleveland. Type rating provided.',
    position_type: 'captain',
    employment_type: 'full_time',
    operation_type: 'part_135',
    base_location: 'Cleveland, OH',
    base_airport_code: 'KCLE',
    work_mode: 'onsite',
    min_total_hours: 3000,
    min_jet_hours: 500,
    required_licenses: ['ATP'],
    salary_min: 145000,
    salary_max: 180000,
    salary_type: 'annual',
    salary_currency: 'USD',
    application_url: 'https://careers.example.com/jobs/7',
    expires_at: '2026-12-07T12:00:00Z'
  })
};

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

import requests

url = "https://{devApiHost}/v1/partner/jobs"

payload = {
    "client_ref": "requisition-20261107-07",
    "title": "Captain, Citation Latitude",
    "description": "Part 135 operation out of Cleveland. Type rating provided.",
    "position_type": "captain",
    "employment_type": "full_time",
    "operation_type": "part_135",
    "base_location": "Cleveland, OH",
    "base_airport_code": "KCLE",
    "work_mode": "onsite",
    "min_total_hours": 3000,
    "min_jet_hours": 500,
    "required_licenses": ["ATP"],
    "salary_min": 145000,
    "salary_max": 180000,
    "salary_type": "annual",
    "salary_currency": "USD",
    "application_url": "https://careers.example.com/jobs/7",
    "expires_at": "2026-12-07T12:00:00Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "job_id": "7b2e4f10-5c1a-4d3e-8f60-1a2b3c4d5e6f",
  "replayed": true
}

{
  "job_id": "7b2e4f10-5c1a-4d3e-8f60-1a2b3c4d5e6f",
  "replayed": false
}

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

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

{
  "error": {
    "code": "forbidden",
    "message": "Operation not permitted.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "partner_not_bound"
  }
}

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

{
  "error": {
    "code": "conflict",
    "message": "Request conflicts with an earlier operation.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "client_ref_reused"
  }
}

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

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "publication_throttled"
  }
}

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

Body

application/json

Maximum 65536 bytes. Unknown or repeated members are rejected.

The members a partner may set. Each is optional here; a create requires its own.

title

string

required

Surrounding whitespace is trimmed.

Minimum string length: 1

position_type

enum<string>

required

Available options:

captain,

first_officer,

check_airman,

instructor,

management,

other,

program

client_ref

string

required

The partner's own name for this create, unique per partner and kind of publication. Send the same ref to retry.

Required string length: 1 - 64

Pattern: ^[A-Za-z0-9._:-]{1,64}$

description

string | null

employment_type

enum<string>

Available options:

full_time,

part_time,

contract,

temporary,

seasonal

operation_type

enum<string>

Available options:

part_121,

part_135,

part_91,

part_91k,

military,

government,

other

base_location

string | null

base_airport_code

string | null

work_mode

enum<string> | null

Available options:

onsite,

hybrid,

remote,

null

min_total_hours

integer | null

Required range: x >= 0

min_pic_hours

integer | null

Required range: x >= 0

min_multi_engine_hours

integer | null

Required range: x >= 0

min_turbine_hours

integer | null

Required range: x >= 0

min_jet_hours

integer | null

Required range: x >= 0

required_licenses

string[]

License codes, such as ATP or CPL.

Minimum string length: 1

required_type_ratings

string[]

FAA type rating designators, such as CE-680.

Minimum string length: 1

salary_min

number | null

salary_max

number | null

At least salary_min.

salary_type

enum<string> | null

Available options:

annual,

hourly,

per_diem,

daily_rate,

monthly,

fixed,

null

salary_currency

string

Pattern: ^[A-Z]{3}$

application_url

string | null

An absolute http or https URL.

application_email

string | null

application_instructions

string | null

expires_at

string<date-time>

RFC 3339. 30 days from the create unless it says otherwise.

status

enum<string>

default:active

Available options:

draft,

active

Response

A retry of a create already made; nothing was published.

job_id

string<uuid>

required

The job; a change and a close name it.

replayed

boolean

required

True when this client_ref had already made the job and nothing was published.

⌘I

Publish a job for the partner's company

curl --request POST \
  --url https://{devApiHost}/v1/partner/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_ref": "requisition-20261107-07",
  "title": "Captain, Citation Latitude",
  "description": "Part 135 operation out of Cleveland. Type rating provided.",
  "position_type": "captain",
  "employment_type": "full_time",
  "operation_type": "part_135",
  "base_location": "Cleveland, OH",
  "base_airport_code": "KCLE",
  "work_mode": "onsite",
  "min_total_hours": 3000,
  "min_jet_hours": 500,
  "required_licenses": [
    "ATP"
  ],
  "salary_min": 145000,
  "salary_max": 180000,
  "salary_type": "annual",
  "salary_currency": "USD",
  "application_url": "https://careers.example.com/jobs/7",
  "expires_at": "2026-12-07T12:00:00Z"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_ref: 'requisition-20261107-07',
    title: 'Captain, Citation Latitude',
    description: 'Part 135 operation out of Cleveland. Type rating provided.',
    position_type: 'captain',
    employment_type: 'full_time',
    operation_type: 'part_135',
    base_location: 'Cleveland, OH',
    base_airport_code: 'KCLE',
    work_mode: 'onsite',
    min_total_hours: 3000,
    min_jet_hours: 500,
    required_licenses: ['ATP'],
    salary_min: 145000,
    salary_max: 180000,
    salary_type: 'annual',
    salary_currency: 'USD',
    application_url: 'https://careers.example.com/jobs/7',
    expires_at: '2026-12-07T12:00:00Z'
  })
};

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

import requests

url = "https://{devApiHost}/v1/partner/jobs"

payload = {
    "client_ref": "requisition-20261107-07",
    "title": "Captain, Citation Latitude",
    "description": "Part 135 operation out of Cleveland. Type rating provided.",
    "position_type": "captain",
    "employment_type": "full_time",
    "operation_type": "part_135",
    "base_location": "Cleveland, OH",
    "base_airport_code": "KCLE",
    "work_mode": "onsite",
    "min_total_hours": 3000,
    "min_jet_hours": 500,
    "required_licenses": ["ATP"],
    "salary_min": 145000,
    "salary_max": 180000,
    "salary_type": "annual",
    "salary_currency": "USD",
    "application_url": "https://careers.example.com/jobs/7",
    "expires_at": "2026-12-07T12:00:00Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "job_id": "7b2e4f10-5c1a-4d3e-8f60-1a2b3c4d5e6f",
  "replayed": true
}

{
  "job_id": "7b2e4f10-5c1a-4d3e-8f60-1a2b3c4d5e6f",
  "replayed": false
}

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

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

{
  "error": {
    "code": "forbidden",
    "message": "Operation not permitted.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "partner_not_bound"
  }
}

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

{
  "error": {
    "code": "conflict",
    "message": "Request conflicts with an earlier operation.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "client_ref_reused"
  }
}

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

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "publication_throttled"
  }
}

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

Publish a job for the partner's company

Authorizations

Body

Response