Get Candidates - Alex Docs

cURL

curl --request GET \
  --url https://api.alex.com/v1/api/candidates \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.alex.com/v1/api/candidates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alex.com/v1/api/candidates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alex.com/v1/api/candidates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.alex.com/v1/api/candidates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "candidateId": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "resumeUrl": "<string>",
    "externalCandidateId": "67890"
  }
]

{
  "error": true,
  "message": "<string>"
}

GET

/

candidates

cURL

curl --request GET \
  --url https://api.alex.com/v1/api/candidates \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.alex.com/v1/api/candidates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alex.com/v1/api/candidates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alex.com/v1/api/candidates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.alex.com/v1/api/candidates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "candidateId": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "resumeUrl": "<string>",
    "externalCandidateId": "67890"
  }
]

{
  "error": true,
  "message": "<string>"
}

Authorizations

X-API-Key

string

header

required

Query Parameters

email

string

The email of the candidate to filter by

candidateId

string

The id of the candidate to filter by

positionId

string

The id of the position to filter by. Filters on candidates that have been interviewed for this position.

Response

Candidates response

candidateId

string

The unique identifier of the candidate

email

string

The email of the candidate

firstName

string

The first name of the candidate

lastName

string

The last name of the candidate

resumeUrl

string | null

The public URL of the candidate's resume, if it exists

externalCandidateId

string | null

The ID of this candidate in the connected ATS, or null if there is no linked ATS record

Example:

"67890"

⌘I