Integrations
Set Up Company Integration
This endpoint serves the purpose of setting up a new company integration with a partner.
POST
/
company
/
integrations
Set Up Company Integration
curl --request POST \
--url https://api.roostedhr.com/api/1_12/company/integrations \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"partner_id": 123,
"api_key": "<string>",
"organization_id": "<string>"
}
'import requests
url = "https://api.roostedhr.com/api/1_12/company/integrations"
payload = {
"partner_id": 123,
"api_key": "<string>",
"organization_id": "<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({partner_id: 123, api_key: '<string>', organization_id: '<string>'})
};
fetch('https://api.roostedhr.com/api/1_12/company/integrations', 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/company/integrations",
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([
'partner_id' => 123,
'api_key' => '<string>',
'organization_id' => '<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/company/integrations"
payload := strings.NewReader("{\n \"partner_id\": 123,\n \"api_key\": \"<string>\",\n \"organization_id\": \"<string>\"\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/company/integrations")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"partner_id\": 123,\n \"api_key\": \"<string>\",\n \"organization_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/company/integrations")
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 \"partner_id\": 123,\n \"api_key\": \"<string>\",\n \"organization_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"secret_key": "sk_live_abc123..."
}{
"code": "CMP-900",
"error": "Invalid integration configuration"
}{
"code": "ATH-100",
"error": "Invalid or missing API key"
}{
"code": "CMP-1000",
"error": "Insufficient permissions to manage company settings"
}{
"code": "CMP-800",
"error": "Integration not found"
}{
"code": "CMP-1100",
"error": "An unexpected error occurred"
}Authorizations
Body
application/json
Integration setup payload.
Response
Created
Generated secret key for the integration
Previous
Update Company IntegrationThis endpoint serves the purpose of updating a company integration's configuration.
Next
⌘I
Set Up Company Integration
curl --request POST \
--url https://api.roostedhr.com/api/1_12/company/integrations \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"partner_id": 123,
"api_key": "<string>",
"organization_id": "<string>"
}
'import requests
url = "https://api.roostedhr.com/api/1_12/company/integrations"
payload = {
"partner_id": 123,
"api_key": "<string>",
"organization_id": "<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({partner_id: 123, api_key: '<string>', organization_id: '<string>'})
};
fetch('https://api.roostedhr.com/api/1_12/company/integrations', 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/company/integrations",
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([
'partner_id' => 123,
'api_key' => '<string>',
'organization_id' => '<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/company/integrations"
payload := strings.NewReader("{\n \"partner_id\": 123,\n \"api_key\": \"<string>\",\n \"organization_id\": \"<string>\"\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/company/integrations")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"partner_id\": 123,\n \"api_key\": \"<string>\",\n \"organization_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/company/integrations")
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 \"partner_id\": 123,\n \"api_key\": \"<string>\",\n \"organization_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"secret_key": "sk_live_abc123..."
}{
"code": "CMP-900",
"error": "Invalid integration configuration"
}{
"code": "ATH-100",
"error": "Invalid or missing API key"
}{
"code": "CMP-1000",
"error": "Insufficient permissions to manage company settings"
}{
"code": "CMP-800",
"error": "Integration not found"
}{
"code": "CMP-1100",
"error": "An unexpected error occurred"
}