Get agency details
const url = 'https://api2.recruso.co.uk/v1/agency';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/agency \ --header 'Authorization: <Authorization>'Returns the configuration of the agency your credentials are bound to: contact details, the financial and holiday year, the working-week shape, and the AWR break thresholds. There is no agency identifier to pass — the agency is always your own.
Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”OK
The configuration of a single agency: who they are, how their financial and holiday years are set up, how their working week is aligned, and the defaults applied to new workers.
object
The agency’s trading name.
The agency’s legal form, e.g. Limited Company.
First line of the agency’s registered address.
Second line of the agency’s registered address.
Postcode of the agency’s registered address.
Primary contact telephone number.
Secondary contact telephone number.
Contact mobile number.
Contact fax number.
Primary contact email address.
The agency’s public website.
The agency’s VAT registration number.
The agency’s Companies House registration number.
The last day of the agency’s tax year.
The first day of the agency’s financial year.
The week-ending date of the agency’s first trading week. Every booking, plan, timesheet and invoice aligns to a week-ending date derived from this anchor, so use it when calculating week boundaries locally rather than assuming a calendar week.
The VAT percentage applied to invoices.
The tax code applied to a new worker when the create-worker request does not supply one.
The day the agency’s working week starts, e.g. Monday. Determines the shape of the week that WeekEndingDateOfFirstWeek anchors.
The Recruso user id (tblUsers.UserID) that last changed the agency record, not the ASP.NET Identity id.
When the agency record was last changed, in UK local time.
Weeks of absence that break a worker’s Agency Worker Regulations qualifying period. The remaining AwR*BreakWeeks fields carry the same threshold for specific absence reasons.
AWR qualifying-period break threshold for sickness absence.
AWR qualifying-period break threshold for jury service.
AWR qualifying-period break threshold for maternity leave.
AWR qualifying-period break threshold for paternity leave.
AWR qualifying-period break threshold for adoption leave.
AWR qualifying-period break threshold for unpaid leave.
The first day of the agency’s holiday year.
When true, each worker’s holiday year runs from their own start date rather than from the agency-wide HolidayYearStartDate.
The maximum hours per week that count towards holiday accrual.
The number of trailing weeks averaged when calculating a worker’s average pay.
Town of the agency’s registered address.
County of the agency’s registered address.
Country of the agency’s registered address.
The agency’s default page size for paged listings.
The worker status type assigned to a newly created worker. When null, workers are created without a status.
When true, holiday pay is rolled up into the hourly rate rather than accrued and paid on leave.
Examplegenerated
{ "ownerName": "example", "businessType": "example", "address1": "example", "address2": "example", "postcode": "example", "telephone1": "example", "telephone2": "example", "mobile": "example", "fax": "example", "email": "example", "website": "example", "vatNumber": "example", "companyRegNumber": "example", "endOfTaxYear": "2026-04-15T12:00:00Z", "yearStartDate": "2026-04-15T12:00:00Z", "weekEndingDateOfFirstWeek": "2026-04-15T12:00:00Z", "currentNi": 1, "freepay": 1, "vatRate": 1, "smsPurchased": 1, "employeeDefaultTaxCode": "example", "customAccountNumber": true, "blockTimesheetAgreement": "example", "firstDayOfWeek": "example", "postCodeSearch": true, "subbyNameInPlan": true, "modifiedBy": "example", "modifiedOn": "2026-04-15T12:00:00Z", "holidayAccrualMethodId": 1, "awRBreakWeeks": 1, "awRSicknessBreakWeeks": 1, "awRJuryServiceBreakWeeks": 1, "awRMaternityBreakWeeks": 1, "awRPaternityBreakWeeks": 1, "awRAdoptionBreakWeeks": 1, "awRUnpaidLeaveBreakWeeks": 1, "holidayYearStartDate": "2026-04-15T12:00:00Z", "holidayYearByWorkStartDate": true, "weeklyCappedHours": 1, "weeksToCalculateAveragePay": 1, "town": "example", "county": "example", "country": "example", "pageSize": 1, "sendSmsAs": "example", "workerDefaultStatus": 1, "customSubContractorAccountNumber": true, "bankDetails": "example", "healthAndSafety": "example", "ppe": "example", "assessmentDetails": "example", "trainingDetails": "example", "inductionDetails": "example", "smsPerBranch": true, "pension": 1, "ssp": 1, "isRolledUpHoliday": true, "calculateVatOnRateType": true, "calculateVatOnClient": true}Unauthorized
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}