Add a client
curl --request POST \
--url https://hiresweep.com/api/openapi/clients \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"notes": "<string>",
"requireApproval": true
}
'import requests
url = "https://hiresweep.com/api/openapi/clients"
payload = {
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"notes": "<string>",
"requireApproval": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
notes: '<string>',
requireApproval: true
})
};
fetch('https://hiresweep.com/api/openapi/clients', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'notes' => '<string>',
'requireApproval' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hiresweep.com/api/openapi/clients"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"notes\": \"<string>\",\n \"requireApproval\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://hiresweep.com/api/openapi/clients")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"notes\": \"<string>\",\n \"requireApproval\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hiresweep.com/api/openapi/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"notes\": \"<string>\",\n \"requireApproval\": true\n}"
response = http.request(request)
puts response.read_body{
"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
}
}{
"defined": true,
"code": "CLIENT_LIMIT_REACHED",
"status": 402,
"message": "Your plan has no room for another active client. Upgrade, or archive a client you no longer apply for.",
"data": {
"limit": 0,
"used": 0,
"plan": "free"
}
}Clients
Add a client
Adds a job seeker you apply for. An active client takes a seat on your operator plan; with every seat taken, or on a plan without seats, it is refused with CLIENT_LIMIT_REACHED. Requires a verified email address. Requires authentication.
POST
/
clients
Add a client
curl --request POST \
--url https://hiresweep.com/api/openapi/clients \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"notes": "<string>",
"requireApproval": true
}
'import requests
url = "https://hiresweep.com/api/openapi/clients"
payload = {
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"notes": "<string>",
"requireApproval": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
notes: '<string>',
requireApproval: true
})
};
fetch('https://hiresweep.com/api/openapi/clients', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'notes' => '<string>',
'requireApproval' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hiresweep.com/api/openapi/clients"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"notes\": \"<string>\",\n \"requireApproval\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://hiresweep.com/api/openapi/clients")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"notes\": \"<string>\",\n \"requireApproval\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hiresweep.com/api/openapi/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"notes\": \"<string>\",\n \"requireApproval\": true\n}"
response = http.request(request)
puts response.read_body{
"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
}
}{
"defined": true,
"code": "CLIENT_LIMIT_REACHED",
"status": 402,
"message": "Your plan has no room for another active client. Upgrade, or archive a client you no longer apply for.",
"data": {
"limit": 0,
"used": 0,
"plan": "free"
}
}Authorizations
An API key from Settings → Developers → API keys in Hiresweep.
Body
application/json
Response
The new client.
The ID of the client.
Where approval links are emailed, when set.
The operator's own notes about the client.
Active clients count against the plan's seats; archived ones do not.
Available options:
active, archived Whether each application waits on the client's approval before it is sent.
Show child attributes
Show child attributes