Get form provided details
GET
/v1/reference/forms-provided/{id}
const url = 'https://api2.recruso.co.uk/v1/reference/forms-provided/1';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api2.recruso.co.uk/v1/reference/forms-provided/1 \ --header 'Authorization: <Authorization>'Returns one form provided by id. Part of a worker’s tax details: which starter form the worker provided. The values are None, Not Required, P45 and Starter Checklist (P46).
Forms provided are platform-wide, so an id means the same form provided for every agency.
An id that does not match a form provided returns 404.
Access. Requires an authenticated token. No further policy is applied.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
integer format: int32
The id path parameter
Responses
Section titled “Responses”OK
Media typeapplication/json
One form provided.
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
{ "id": 1, "name": "P45"}Unauthorized
Media typeapplication/problem+json
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
Media typeapplication/problem+json
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}