Easyteam Embedded
GuidesAPIWhite-Label UIs
GuidesAPIWhite-Label UIs
  1. Time Off
  • Getting started
    • Authentication
      • Authentication Quick Start
      • Exchange Token
    • Permissions
      • Create Access Role
      • List Access Roles
      • Get Access Role
      • Update Access Role
      • Delete Access Role
  • Organizations
    • List Organizations
    • Get Organization
    • Get Organization by External ID
    • Create Organization
    • Create Organization With Defaults
    • Sync Locations
    • Update Organization
    • Delete Organization
    • Delete Organization by External ID
  • Locations
    • Retrieve all locations
    • Retrieve a specific location
    • Retrieve a specific location by external ID
    • Create a new location
    • Update a specific location
    • Delete a specific location
    • Retrieve timesheets for a specific location
    • Retrieve staff members for a specific location
  • Staff members
    • Retrieve all staff members
    • Retrieve a specific staff member
    • Retrieve a staff member by external ID
    • Retrieve staff member locations
    • Create a new staff member
    • Synchronize staff members
    • Update a specific staff member
    • Delete a specific staff member
  • Roles
    • Create a new role
    • Retrieve all roles
    • Retrieve a specific role
    • Update a specific role
    • Delete a specific role
  • Time Tracking
    • Retrieve staff member shift state
    • Clock in a staff member
    • Clock out a staff member
  • Breaks
    • Retrieve break types for a specific location
    • Create a new break type for a location
    • Update a specific break type
    • Delete a specific break type
  • Timesheets
    • Retrieve all shifts
    • Retrieve a specific shift
    • Export shifts
    • Generate per-employee shift reports
    • Generate shift reports
    • Create a new shift
    • Update a specific shift
    • Delete a specific shift
    • Delete all shifts on a specific date
  • Time Off
    • Retrieve all time off policies
      GET
    • Retrieve a policy
      GET
    • List all policy types
      GET
    • Create Policy
      POST
    • Update Policy
      PATCH
    • Activate Policy
      PATCH
    • Deactivate Policy
      PATCH
    • Get Worker Policies
      GET
    • List all worker policies
      GET
  • Requests and Approval
    • Get Time-Off Request
    • List Time-Offs
    • Create a time off request
    • Update Time-Off Request
    • Delete Time-Off Request
    • Approve Time-Off Request
    • Decline Time-Off Request
  • Shift Notes
    • Working with shift notes
    • List shift notes from current shift
    • Create shift note on current shift
  • Schedules
    • List all schedule entries
    • Get details for a schedule
    • Create schedule entry
    • Bulk copy schedule shifts
    • Update schedule entry
    • Remove schedule entry
    • List all draft schedule entries
    • Get details for a draft entry
    • Create draft schedule entry
    • Update draft entry
    • Remove draft schedule entry
    • Publish draft schedule
    • List open shifts
    • Get details for an open shift
    • Create open shift
    • Update open shift
    • Remove open shift
    • Claim open shift
    • Retract open shift submission
    • Create open shift preference
    • Retract open shift preference
    • Update open shift preference
    • Remove open shift preference
    • Assign or accept open shift preference
    • Bulk assign or accept open shift preferences
  • Settings
    • Retrieve organization time off settings
    • Update organization time off settings
  • Notifications
    • Coming soon
  1. Time Off

Retrieve all time off policies

GET
/api/organizations/{organization_id}/policies
Retrieves all time off policies configured for a specific organization.

Request

Path Params

Query Params

Responses

🟢200OK
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/organizations//policies?fetchAllStatuses'
Response Response Example
[
    {
        "id": "string",
        "organizationId": "string",
        "name": "string",
        "allowNegativeBalance": true,
        "assignedStaffCount": 0,
        "carryoverLimit": 0,
        "defaultSettings": {
            "assignedStaff": {
                "type": "Role",
                "value": "string"
            }
        },
        "fullDayDuration": 0,
        "limitSettings": {
            "isFixedAmount": true,
            "fixedAmount": {
                "hours": 0,
                "daysEarned": 0,
                "accrualCycle": "AllAtOnce",
                "accrualFrequency": "EveryOneWeek",
                "accrualDay": "Sunday",
                "accrualDate": "1st"
            },
            "perHourEarnings": {
                "hoursEarned": 0,
                "hoursWorked": 0,
                "isLimitedMaximumBalance": true,
                "maximumHoursBalance": 0
            }
        },
        "paid": true,
        "requiresApproval": true,
        "status": "Draft",
        "type": {
            "id": "string",
            "name": "string",
            "type": "Sick"
        },
        "typeId": "string",
        "units": "days",
        "createdAt": "string",
        "updatedAt": "string"
    }
]
Modified at 2025-03-24 12:32:20
Previous
Delete all shifts on a specific date
Next
Retrieve a policy