Skip to content
Recruso API

List payment frequencies

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

Returns every payment frequency the platform publishes. How often a worker prefers to be paid. The values are Weekly, Fortnightly, Four Weekly and Monthly.

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 payment frequency 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

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

Every payment frequency the platform publishes.

object
paymentFrequencies
required

The payment frequencies. Never null.

Array<object>

One payment frequency in a list.

object
id

The payment frequency’s identifier. Stable and platform-wide — the same id means the same thing for every agency.

integer format: int16
name

The payment frequency name, as it appears in Recruso. Up to 50 characters. Unique across all payment frequencies.

string
Example
{
  "paymentFrequencies": [
    {
      "id": 1,
      "name": "Weekly"
    }
  ]
}

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