Overview
Clients
Payroll Groups
Rate Cards
Time Tracking
Wage Rules
Rules
Get Client Rules
Returns all worker matching rules for a specific client, grouped by category (fields, credentials, has_tags, does_not_have_tags).
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>'{
"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
Path Parameters
Client ID
Response
OK
Rules based on custom fields.
Show child attributes
Show child attributes
Rules based on credentials.
Show child attributes
Show child attributes
Rules requiring specific tags.
Show child attributes
Show child attributes
Rules excluding specific tags.
Show child attributes
Show child attributes
Previous
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.
Next
⌘I
Get Client Rules
curl --request GET \
--url https://api.roostedhr.com/api/1_12/clients/{id}/rules \
--header 'X-API-KEY: <api-key>'{
"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>"
}
]
}
]
}