Skip to content

Get primary rate type details

GET
/v1/reference/primary-rate-types/{id}
curl --request GET \
--url https://api2.recruso.co.uk/v1/reference/primary-rate-types/1 \
--header 'Authorization: <Authorization>'

Returns one primary rate type by id. The bands a client’s rates are set up under, which decide what a worker’s hours are paid at. Weekday, Saturday, Sunday and bank holiday each have a basic and an overtime band, alongside Nightout, Pre Tax Expense, Post Tax Expense and Deduction.

Primary rate types are platform-wide, so an id means the same primary rate type for every agency.

An id that does not match a primary rate type returns 404.

Access. Requires an authenticated token. No further policy is applied.

id
required
integer format: int32

The id path parameter

OK

Media typeapplication/json

One primary rate type.

object
id

The primary rate type’s identifier. Stable and platform-wide — the same id means the same thing for every agency.

integer format: int16
name

The primary rate type name, as it appears in Recruso. Up to 50 characters. Unique across all primary rate types.

string
Example
{
"id": 1,
"name": "Hourly"
}

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"
}

Not Found

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"
}