Agency

Agency represents the tenants of the Recruso. Each agency operates independently, with its own data and configuration.

🏢 An agency corresponds to a recruitment business using Recruso to manage its branches, clients, workers, and financial operations.

Overview

• Agencies define their own operational rules, such as:

  • Work week structure (e.g., Monday–Sunday or Sunday–Saturday)
  • Holiday year and calendar year
  • Holiday caps and compliance rules
  • Regional and payroll settings

• Agencies can have multiple branches and clients, but data between agencies is always isolated.

Creation and Lifecycle

Agencies are not created or deleted through the public API. They are manually set up by the Recruso onboarding team during client implementation.

This ensures:

• Proper setup of database isolation.
• Consistent initialization of default branches, admin users, and configuration templates.

⚙️ If you are a new client integrating with Recruso CRM, your agency will be created as part of the onboarding process. Once created, you can use API endpoints to manage all entities under your agency (branches, clients, sites, workers, etc.).

API Endpoints

Get Current Agency

Retrieve details of the agency associated with the authenticated user.

GET /api/agency/

Response Example

{
  "name": "Recruso Ltd",
  "email": "support@recruso.co.uk",
  "phone": "08450 511 055",
  "workWeekStart": "Monday",
  "calendarYearStart": "2025-01-01",
  "holidayYearStart": "2025-01-01",
  "holidayCapHours": 48
}

Typical Usage

Client applications or partner systems do not create or modify agencies. Instead, they use:

• /api/agency to retrieve agency details (e.g., work week, holiday year, calendar year) for local calculations.
• Other module APIs (/api/branches, /api/clients, etc.) for operational data tied to that agency.

Example Use Case

Scenario: A mobile app that syncs worker weekly plans needs to display work week boundaries correctly.

Steps:

1. Call GET /api/agency to fetch weekEndingDate.
2. Use the value to calculate start/end of weeks when displaying weekly plans.
3. Continue using /api/workers/weeklyplans endpoints scoped to that agency.

Summary

👉 Next: Branches — Learn how to manage agency branches and their operational data.