API Authentication - SignalHire API

All requests must include the API key in the request header.

Obtaining an API Key

Register for a SignalHire account
Open the left sidebar and navigate to Other tools → Integrations & API
Click Create new API Key, then copy the generated key using the copy icon next to it

Integrations and API in the left sidebar — Integrations & API under Other tools in the left sidebar

Create new API Key button and copy icon — Creating and copying your API key

Using the API Key

Include the apikey header in every request:

curl -X POST https://www.signalhire.com/api/v1/candidate/search \
-H 'apikey: your_secret_api_key' \
--data '{"items": [...], "callbackUrl": "https://yourdomain.com/callback"}'

import requests

response = requests.post(
"https://www.signalhire.com/api/v1/candidate/search",
headers={"apikey": "your_secret_api_key"},
json={
"items": [...],
"callbackUrl": "https://yourdomain.com/callback"
}
)

const axios = require('axios');

const response = await axios.post(
'https://www.signalhire.com/api/v1/candidate/search',
{
    items: [...],
    callbackUrl: 'https://yourdomain.com/callback'
},
{
    headers: { apikey: 'your_secret_api_key' }
}
);

import java.net.http.*;
import java.net.URI;

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://www.signalhire.com/api/v1/candidate/search"))
.header("apikey", "your_secret_api_key")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(
"{\"items\": [...], \"callbackUrl\": \"https://yourdomain.com/callback\"}"
))
.build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

    require 'net/http'
    require 'json'

    uri = URI('https://www.signalhire.com/api/v1/candidate/search')
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true

    request = Net::HTTP::Post.new(uri)
    request['apikey'] = 'your_secret_api_key'
    request['Content-Type'] = 'application/json'
    request.body = {
    items: [...],
    callbackUrl: 'https://yourdomain.com/callback'
}.to_json

    response = http.request(request)

API keys must be kept secure. Exposing a key in public repositories or sharing it with unauthorized parties allows others to make API calls consuming paid credits.

Checking Remaining Credits

The X-Credits-Left header is included in every API response and shows the current credit balance.

    HTTP/2 201
    Content-Type: application/json
    X-Credits-Left: 243

Credits can also be checked explicitly — see Get Remaining Credits.