Skip to content
Recruso API

Overview

Reference data 1.0.0

Section titled “Reference data 1.0.0”

Platform-wide read-only vocabularies — titles, genders, nationalities, worker types and the rest — identical for every agency. A worker or client record refers to these by id, so they are the values you need before you can create one. Distinct from Lookups, which your agency owns and configures.

Information

  • OpenAPI version: 3.0.1

Operations

Section titled “Operations”
GET
/v1/reference/bank-account-types
GET
/v1/reference/bank-account-types/{id}
GET
/v1/reference/client-invoice-types
GET
/v1/reference/client-invoice-types/{id}
GET
/v1/reference/client-status-types
GET
/v1/reference/client-status-types/{id}
GET
/v1/reference/client-types
GET
/v1/reference/client-types/{id}
GET
/v1/reference/driving-conviction-codes
GET
/v1/reference/driving-conviction-codes/{id}
GET
/v1/reference/ethnic-origins
GET
/v1/reference/ethnic-origins/{id}
GET
/v1/reference/forms-provided
GET
/v1/reference/forms-provided/{id}
GET
/v1/reference/genders
GET
/v1/reference/genders/{id}
GET
/v1/reference/holiday-types
GET
/v1/reference/holiday-types/{id}
GET
/v1/reference/invoice-methods
GET
/v1/reference/invoice-methods/{id}
GET
/v1/reference/marital-statuses
GET
/v1/reference/marital-statuses/{id}
GET
/v1/reference/ni-categories
GET
/v1/reference/ni-categories/{id}
GET
/v1/reference/nationalities
GET
/v1/reference/nationalities/{id}
GET
/v1/reference/payment-frequencies
GET
/v1/reference/payment-frequencies/{id}
GET
/v1/reference/payment-methods
GET
/v1/reference/payment-methods/{id}
GET
/v1/reference/primary-rate-types
GET
/v1/reference/primary-rate-types/{id}
GET
/v1/reference/sub-contractor-status-types
GET
/v1/reference/sub-contractor-status-types/{id}
GET
/v1/reference/titles
GET
/v1/reference/titles/{id}
GET
/v1/reference/vehicle-categories
GET
/v1/reference/vehicle-categories/{id}
GET
/v1/reference/worker-status-types
GET
/v1/reference/worker-status-types/{id}
GET
/v1/reference/worker-types
GET
/v1/reference/worker-types/{id}

Authentication

Section titled “Authentication”

Bearer

Section titled “Bearer”

JWT Authorization header using the bearer scheme

Security scheme type: apiKey

Header parameter name: Authorization