Workers
Add Transferred Workers
Transfers a batch of workers (up to 100) into the company. Each worker must include at minimum name_first, name_last, and email.
POST
/
workers
/
transferred-workers
Add Transferred Workers
curl --request POST \
--url https://api.roostedhr.com/api/1_12/workers/transferred-workers \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
[
{
"name_first": "<string>",
"name_last": "<string>",
"email": "<string>",
"formatted_name": "<string>",
"phone": "<string>",
"address": "<string>",
"city": "<string>",
"zip": "<string>",
"applied_position": "<string>",
"document_links": [
{
"link": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"documents": [
{
"file": "<string>",
"name": "<string>",
"type": "<string>"
}
]
}
]
'import requests
url = "https://api.roostedhr.com/api/1_12/workers/transferred-workers"
payload = [
{
"name_first": "<string>",
"name_last": "<string>",
"email": "<string>",
"formatted_name": "<string>",
"phone": "<string>",
"address": "<string>",
"city": "<string>",
"zip": "<string>",
"applied_position": "<string>",
"document_links": [
{
"link": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"documents": [
{
"file": "<string>",
"name": "<string>",
"type": "<string>"
}
]
}
]
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_first: '<string>',
name_last: '<string>',
email: '<string>',
formatted_name: '<string>',
phone: '<string>',
address: '<string>',
city: '<string>',
zip: '<string>',
applied_position: '<string>',
document_links: [{link: '<string>', name: '<string>', type: '<string>'}],
documents: [{file: '<string>', name: '<string>', type: '<string>'}]
}
])
};
fetch('https://api.roostedhr.com/api/1_12/workers/transferred-workers', 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.roostedhr.com/api/1_12/workers/transferred-workers",
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_first' => '<string>',
'name_last' => '<string>',
'email' => '<string>',
'formatted_name' => '<string>',
'phone' => '<string>',
'address' => '<string>',
'city' => '<string>',
'zip' => '<string>',
'applied_position' => '<string>',
'document_links' => [
[
'link' => '<string>',
'name' => '<string>',
'type' => '<string>'
]
],
'documents' => [
[
'file' => '<string>',
'name' => '<string>',
'type' => '<string>'
]
]
]
]),
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://api.roostedhr.com/api/1_12/workers/transferred-workers"
payload := strings.NewReader("[\n {\n \"name_first\": \"<string>\",\n \"name_last\": \"<string>\",\n \"email\": \"<string>\",\n \"formatted_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"applied_position\": \"<string>\",\n \"document_links\": [\n {\n \"link\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\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://api.roostedhr.com/api/1_12/workers/transferred-workers")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"name_first\": \"<string>\",\n \"name_last\": \"<string>\",\n \"email\": \"<string>\",\n \"formatted_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"applied_position\": \"<string>\",\n \"document_links\": [\n {\n \"link\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/workers/transferred-workers")
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 {\n \"name_first\": \"<string>\",\n \"name_last\": \"<string>\",\n \"email\": \"<string>\",\n \"formatted_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"applied_position\": \"<string>\",\n \"document_links\": [\n {\n \"link\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"workers_transferred": 11
}Authorizations
Body
application/json
Array of worker objects
Required array length:
1 - 100 elementsRequired string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 255Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
OK
Number of workers successfully transferred.
Required range:
1 <= x <= 100Previous
Get Worker AvailabilityReturns availability entries for a specific worker from today forward.
Next
⌘I
Add Transferred Workers
curl --request POST \
--url https://api.roostedhr.com/api/1_12/workers/transferred-workers \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
[
{
"name_first": "<string>",
"name_last": "<string>",
"email": "<string>",
"formatted_name": "<string>",
"phone": "<string>",
"address": "<string>",
"city": "<string>",
"zip": "<string>",
"applied_position": "<string>",
"document_links": [
{
"link": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"documents": [
{
"file": "<string>",
"name": "<string>",
"type": "<string>"
}
]
}
]
'import requests
url = "https://api.roostedhr.com/api/1_12/workers/transferred-workers"
payload = [
{
"name_first": "<string>",
"name_last": "<string>",
"email": "<string>",
"formatted_name": "<string>",
"phone": "<string>",
"address": "<string>",
"city": "<string>",
"zip": "<string>",
"applied_position": "<string>",
"document_links": [
{
"link": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"documents": [
{
"file": "<string>",
"name": "<string>",
"type": "<string>"
}
]
}
]
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_first: '<string>',
name_last: '<string>',
email: '<string>',
formatted_name: '<string>',
phone: '<string>',
address: '<string>',
city: '<string>',
zip: '<string>',
applied_position: '<string>',
document_links: [{link: '<string>', name: '<string>', type: '<string>'}],
documents: [{file: '<string>', name: '<string>', type: '<string>'}]
}
])
};
fetch('https://api.roostedhr.com/api/1_12/workers/transferred-workers', 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.roostedhr.com/api/1_12/workers/transferred-workers",
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_first' => '<string>',
'name_last' => '<string>',
'email' => '<string>',
'formatted_name' => '<string>',
'phone' => '<string>',
'address' => '<string>',
'city' => '<string>',
'zip' => '<string>',
'applied_position' => '<string>',
'document_links' => [
[
'link' => '<string>',
'name' => '<string>',
'type' => '<string>'
]
],
'documents' => [
[
'file' => '<string>',
'name' => '<string>',
'type' => '<string>'
]
]
]
]),
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://api.roostedhr.com/api/1_12/workers/transferred-workers"
payload := strings.NewReader("[\n {\n \"name_first\": \"<string>\",\n \"name_last\": \"<string>\",\n \"email\": \"<string>\",\n \"formatted_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"applied_position\": \"<string>\",\n \"document_links\": [\n {\n \"link\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\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://api.roostedhr.com/api/1_12/workers/transferred-workers")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"name_first\": \"<string>\",\n \"name_last\": \"<string>\",\n \"email\": \"<string>\",\n \"formatted_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"applied_position\": \"<string>\",\n \"document_links\": [\n {\n \"link\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/workers/transferred-workers")
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 {\n \"name_first\": \"<string>\",\n \"name_last\": \"<string>\",\n \"email\": \"<string>\",\n \"formatted_name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"applied_position\": \"<string>\",\n \"document_links\": [\n {\n \"link\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"workers_transferred": 11
}