List primary rate types

GET

/v1/reference/primary-rate-types

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

• Production

Returns every primary rate type the platform publishes. 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.

These values are platform-wide: every agency sees the same list and the same ids, and your agency cannot add to them or change them. No endpoint published on this API takes a primary rate type id yet; the vocabulary is published so that its values are enumerable.

The list is not paged, and no order is guaranteed — sort client-side if you need one. The values change very rarely, so cache them rather than fetching them before every call.

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

Authorizations

• Bearer

Responses

200

OK

Media typeapplication/json

Every primary rate type the platform publishes.

object

primaryRateTypes

required

The primary rate types. Never null.

Array<object>

One primary rate type in a list.

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

{
  "primaryRateTypes": [
    {
      "id": 1,
      "name": "Hourly"
    }
  ]
}

401

Unauthorized

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}