List National Insurance categories
const url = 'https://api2.recruso.co.uk/v1/reference/ni-categories';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/ni-categories \ --header 'Authorization: <Authorization>'Returns every National Insurance category the platform publishes. The HMRC National Insurance category letter a worker is paid under.
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. Use the id wherever a request asks for a National Insurance category — niCategoryId on CreateWorker.
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”OK
Every National Insurance category the platform publishes.
object
The National Insurance categories. Never null.
One National Insurance category in a list.
object
The National Insurance category’s identifier. Stable and platform-wide — the same id means the same thing for every agency.
The National Insurance category name, as it appears in Recruso. Up to 10 characters. Unique across all National Insurance categories.
A longer description of the National Insurance category. May be null.
Example
{ "niCategories": [ { "id": 1, "name": "A", "description": "Standard rate" } ]}Unauthorized
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}