Get Client Rules

GET

clients

{id}

rules

Get Client Rules

curl --request GET \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/rules \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.roostedhr.com/api/1_12/clients/{id}/rules"

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://api.roostedhr.com/api/1_12/clients/{id}/rules', 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/clients/{id}/rules",
  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://api.roostedhr.com/api/1_12/clients/{id}/rules"

	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://api.roostedhr.com/api/1_12/clients/{id}/rules")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roostedhr.com/api/1_12/clients/{id}/rules")

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

{
  "fields": [
    {
      "fields": [
        {
          "id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "credentials": [
        {
          "id": "<string>",
          "credentials_id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "has_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ],
      "does_not_have_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ]
    }
  ],
  "credentials": [
    {
      "fields": [
        {
          "id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "credentials": [
        {
          "id": "<string>",
          "credentials_id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "has_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ],
      "does_not_have_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ]
    }
  ],
  "has_tags": [
    {
      "fields": [
        {
          "id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "credentials": [
        {
          "id": "<string>",
          "credentials_id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "has_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ],
      "does_not_have_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ]
    }
  ],
  "does_not_have_tags": [
    {
      "fields": [
        {
          "id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "credentials": [
        {
          "id": "<string>",
          "credentials_id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "has_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ],
      "does_not_have_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ]
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

string

required

Client ID

Response

fields

ClientRule · object[]

Rules based on custom fields.

Show child attributes

credentials

ClientRule · object[]

Rules based on credentials.

Show child attributes

has_tags

ClientRule · object[]

Rules requiring specific tags.

Show child attributes

does_not_have_tags

ClientRule · object[]

Rules excluding specific tags.

Show child attributes

Create Client RuleCreates a new worker matching rule for a specific client. Rules filter which workers are eligible for this client's events based on custom field values, credentials, and tags.

Get Client Rules

curl --request GET \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/rules \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.roostedhr.com/api/1_12/clients/{id}/rules"

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://api.roostedhr.com/api/1_12/clients/{id}/rules', 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/clients/{id}/rules",
  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://api.roostedhr.com/api/1_12/clients/{id}/rules"

	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://api.roostedhr.com/api/1_12/clients/{id}/rules")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roostedhr.com/api/1_12/clients/{id}/rules")

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

{
  "fields": [
    {
      "fields": [
        {
          "id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "credentials": [
        {
          "id": "<string>",
          "credentials_id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "has_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ],
      "does_not_have_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ]
    }
  ],
  "credentials": [
    {
      "fields": [
        {
          "id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "credentials": [
        {
          "id": "<string>",
          "credentials_id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "has_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ],
      "does_not_have_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ]
    }
  ],
  "has_tags": [
    {
      "fields": [
        {
          "id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "credentials": [
        {
          "id": "<string>",
          "credentials_id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "has_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ],
      "does_not_have_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ]
    }
  ],
  "does_not_have_tags": [
    {
      "fields": [
        {
          "id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "credentials": [
        {
          "id": "<string>",
          "credentials_id": "<string>",
          "field_id": "<string>",
          "field_type": "<string>",
          "field_name": "<string>",
          "name": "<string>",
          "operator": "<string>",
          "answers": [
            {
              "id": "<string>",
              "display": "<string>"
            }
          ],
          "value": "<string>"
        }
      ],
      "has_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ],
      "does_not_have_tags": [
        {
          "rule_id": "<string>",
          "id": "<string>",
          "text": "<string>",
          "operator": "<string>"
        }
      ]
    }
  ]
}

Overview

Announcements

Areas

Clients

Company

Configuration

Events

Locations

Payroll Groups

Rate Cards

Skillsets

Time Tracking

Wage Rules

Workers

Authorizations

Path Parameters

Response