Skip to content
Recruso API

List AWR alert rules

GET
/v1/awr-alert-rules
curl --request GET \
  --url https://api2.recruso.co.uk/v1/awr-alert-rules \
  --header 'Authorization: <Authorization>'

Returns your agency’s AWR alert rules, ordered by weekThreshold. Under the Agency Workers Regulations a worker reaches parity in week 12, and these rules decide which of the weeks up to that point your agency is alerted in — a single week, or every week until parity is reached.

The response is not paged.

You only ever see and change your own agency’s records; there is no owner id on the request, and an id belonging to another agency returns 404 rather than 403 so that its existence is never disclosed.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
awrAlertRules
required
Array<object>
object
alertId
required
integer format: int32
weekThreshold
required
integer format: uint8
nullable
isActive
required
boolean
nullable
Examplegenerated
{
  "awrAlertRules": [
    {
      "alertId": 1,
      "weekThreshold": 1,
      "isActive": true
    }
  ]
}

401

Section titled “401”

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}