Skip to content
Recruso API

List forms provided

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

Returns every form provided the platform publishes. Part of a worker’s tax details: which starter form the worker provided. The values are None, Not Required, P45 and Starter Checklist (P46).

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 form provided 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 form provided the platform publishes.

object
formsProvided
required

The forms provided. Never null.

Array<object>

One form provided in a list.

object
id

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

integer format: int16
name

The form provided name, as it appears in Recruso. Up to 50 characters. Unique across all forms provided.

string
Example
{
  "formsProvided": [
    {
      "id": 1,
      "name": "P45"
    }
  ]
}

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