List the roles you are working on
The active roles you are working on: every role where you hold a primary slot (including one on trial), plus every role where you have an active submission, meaning a candidate you submitted who is submitted, reviewed, interviewing, or at offer stage. Paused and closed roles are not listed. To find new roles to work on, use listRecruiterRoles; for a role’s full detail, use getRecruiterRole.
primaryOnly, activeTrialOnly, singleSubmissionsOnly and paraAiOnly narrow the list. When several are true, a role matching ANY of them is returned. activeTrialOnly matches a trial still inside its window whose submission goal is not yet met. singleSubmissionsOnly and paraAiOnly match whether or not you also hold a primary slot on the role.
Ordered by the role’s last update, newest first, then role ID. A page holds at most 100 roles, and can hold fewer roles than limit, or none, while nextCursor is set; continue until nextCursor is null.
fee is what the placement pays you, the same figures listRecruiterRoles returns. Amounts are in baseSalary.currency; a null currency means it is not recorded. When your agency hides payment from its members, every fee field is null; agency owners always see fees. fee itself is null when the role’s fee cannot be read through this endpoint.
A confidential stealth role you are not assigned to shows as “Confidential (Stealth)”, with the company name removed from its title and locations.
Required scopes: roles:read.
curl --request GET \
--url https://external-api.paraform.com/api/external/v1/recruiter/active-roles \
--header 'Authorization: Bearer <token>'import requests
url = "https://external-api.paraform.com/api/external/v1/recruiter/active-roles"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://external-api.paraform.com/api/external/v1/recruiter/active-roles', 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://external-api.paraform.com/api/external/v1/recruiter/active-roles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://external-api.paraform.com/api/external/v1/recruiter/active-roles"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://external-api.paraform.com/api/external/v1/recruiter/active-roles")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://external-api.paraform.com/api/external/v1/recruiter/active-roles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"roles": [
{
"id": "<string>",
"title": "<string>",
"company": {
"name": "<string>"
},
"status": "ACTIVE",
"locations": [
"<string>"
],
"workplaceType": "REMOTE",
"baseSalary": {
"currency": "<string>",
"min": 123,
"max": 123
},
"updatedAt": "2023-11-07T05:31:56Z",
"fee": {
"amountLowerBound": 123,
"percentOfSalary": 123,
"boostPercent": 123,
"bonusAmount": 123,
"firstSubmissionReward": 123
}
}
],
"nextCursor": "<string>"
}Authorizations
Query Parameters
curl --request GET \
--url https://external-api.paraform.com/api/external/v1/recruiter/active-roles \
--header 'Authorization: Bearer <token>'import requests
url = "https://external-api.paraform.com/api/external/v1/recruiter/active-roles"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://external-api.paraform.com/api/external/v1/recruiter/active-roles', 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://external-api.paraform.com/api/external/v1/recruiter/active-roles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://external-api.paraform.com/api/external/v1/recruiter/active-roles"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://external-api.paraform.com/api/external/v1/recruiter/active-roles")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://external-api.paraform.com/api/external/v1/recruiter/active-roles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"roles": [
{
"id": "<string>",
"title": "<string>",
"company": {
"name": "<string>"
},
"status": "ACTIVE",
"locations": [
"<string>"
],
"workplaceType": "REMOTE",
"baseSalary": {
"currency": "<string>",
"min": 123,
"max": 123
},
"updatedAt": "2023-11-07T05:31:56Z",
"fee": {
"amountLowerBound": 123,
"percentOfSalary": 123,
"boostPercent": 123,
"bonusAmount": 123,
"firstSubmissionReward": 123
}
}
],
"nextCursor": "<string>"
}