Authentication

Every request to the Partner API must include an API key.

Getting a key

Partner API keys are issued by request — reach out to your Apploi contact or
[email protected] to get one. There is currently no
self-service way to generate a key.

Sending your key

Send your key in the X-Api-Key header on every request:

curl https://partners.apploi.com/applicants \
  -H "X-Api-Key: YOUR_API_KEY"

import requests

response = requests.get(
    "https://partners.apploi.com/applicants",
    headers={"X-Api-Key": "YOUR_API_KEY"},
)

const response = await fetch("https://partners.apploi.com/applicants", {
  headers: { "X-Api-Key": "YOUR_API_KEY" },
});

require "net/http"
require "uri"

uri = URI("https://partners.apploi.com/applicants")
request = Net::HTTP::Get.new(uri)
request["X-Api-Key"] = "YOUR_API_KEY"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

Deprecated: Authorization: Bearer and /v1/users/login

Some parts of the API — the /easy-apply endpoint and POST /v1/users/login — also
accept an Authorization: Bearer <token> header, using a token obtained from either
endpoint's own response. This flow is deprecated and being sunset. New integrations
should authenticate with X-Api-Key instead. If you're still using the bearer-token flow,
plan to migrate — watch for a follow-up communication with removal timelines.

Authentication failures

See Errors & Troubleshooting for the full
status-code catalog, including how to tell the different 403 cases apart.