A client's applications report
curl --request GET \
--url https://hiresweep.com/api/openapi/clients/{id}/report \
--header 'x-api-key: <api-key>'import requests
url = "https://hiresweep.com/api/openapi/clients/{id}/report"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://hiresweep.com/api/openapi/clients/{id}/report', 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://hiresweep.com/api/openapi/clients/{id}/report",
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://hiresweep.com/api/openapi/clients/{id}/report"
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))
}HttpResponse<String> response = Unirest.get("https://hiresweep.com/api/openapi/clients/{id}/report")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://hiresweep.com/api/openapi/clients/{id}/report")
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{
"client": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"notes": "<string>",
"status": "active",
"requireApproval": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"counts": {
"applications": 0,
"submitted": 0,
"byStatus": {},
"pendingApprovals": 0,
"unseenDecisions": 0
}
},
"summary": {
"applications": 0,
"submitted": 0,
"interviews": 0,
"offers": 0,
"byStatus": {}
},
"applications": [
{
"status": "saved",
"statusChangedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"submittedAt": "2023-11-07T05:31:56Z",
"matchScore": 0,
"title": "<string>",
"company": "<string>",
"location": "<string>",
"url": "<string>",
"approval": {
"status": "pending",
"decidedAt": "2023-11-07T05:31:56Z"
},
"id": "<string>"
}
],
"reportUrl": "<string>"
}Clients
A client's applications report
Returns every application for a client with its status, match score, dates and approval state, with totals, and the client’s report link when one is on. Requires authentication.
GET
/
clients
/
{id}
/
report
A client's applications report
curl --request GET \
--url https://hiresweep.com/api/openapi/clients/{id}/report \
--header 'x-api-key: <api-key>'import requests
url = "https://hiresweep.com/api/openapi/clients/{id}/report"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://hiresweep.com/api/openapi/clients/{id}/report', 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://hiresweep.com/api/openapi/clients/{id}/report",
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://hiresweep.com/api/openapi/clients/{id}/report"
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))
}HttpResponse<String> response = Unirest.get("https://hiresweep.com/api/openapi/clients/{id}/report")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://hiresweep.com/api/openapi/clients/{id}/report")
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{
"client": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"notes": "<string>",
"status": "active",
"requireApproval": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"counts": {
"applications": 0,
"submitted": 0,
"byStatus": {},
"pendingApprovals": 0,
"unseenDecisions": 0
}
},
"summary": {
"applications": 0,
"submitted": 0,
"interviews": 0,
"offers": 0,
"byStatus": {}
},
"applications": [
{
"status": "saved",
"statusChangedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"submittedAt": "2023-11-07T05:31:56Z",
"matchScore": 0,
"title": "<string>",
"company": "<string>",
"location": "<string>",
"url": "<string>",
"approval": {
"status": "pending",
"decidedAt": "2023-11-07T05:31:56Z"
},
"id": "<string>"
}
],
"reportUrl": "<string>"
}Authorizations
An API key from Settings → Developers → API keys in Hiresweep.
Path Parameters
The ID of the client.
Minimum string length:
1