Overview

The Company Policies API lets you manage the policy families that govern how employees are paid and how they can be scheduled. Integrators and the Connecteam agent use the same endpoints: the agent relies on this surface to help admins attach the right policies during setup.

📘

Three families, one API

Pay rules, scheduling rules, and working hours. Same company_policies scopes. Different assignment rules. Use the guide for the family you are integrating.

Key Concepts

Pay Rule Policies

Pay rule policies determine how employee work hours are calculated for payroll:

• Overtime calculation rules
• Shift differentials and premiums
• Regular vs overtime hour thresholds
• Additional hourly rate conditions

Each user is assigned to a pay rule policy with an effective date. If the new effective date is earlier than an existing assignment, the old assignment is replaced. Historical assignments affect payroll calculations retroactively. You can list the reusable pay rules, see which rules sit in each policy, add or remove a rule, list who is assigned, and remove an assignment. The Connecteam agent uses this surface to help admins attach the right pay structure during setup.

🚧

Effective dates change payroll

Assign and unassign are dated. A date that lands on approved or locked timesheet days is rejected. Composition changes (add or remove a rule) apply immediately to everyone on the policy.

Scheduling Rule Policies

Scheduling rule policies are named bundles of labor constraints that Job Schedule enforces:

• Maximum hours or shifts per day and per week
• Minimum hours or shifts per week
• Minimum rest between shifts (minHoursBetweenShifts)

Assignments take effect immediately (no effective date). An employee can also have custom scheduling rules on their profile; those are returned only on the per-user GET. Create and edit policy contents in the dashboard; use the API to list policies, look up who they apply to, assign users, and delete a policy. The Connecteam agent uses these same endpoints to help admins attach the right policy during setup.

👍

Immediate, not dated

There is no public unassign. Move someone to a different policy, or delete the policy (which drops every assignment). Custom profile rules stay in place.

Working Hours Policies

Working hours policies define an employee's expected week:

• Which days are work days
• Allowed time windows on each day
• Expected daily duration
• Timezone the windows are evaluated in

A user has at most one working hours configuration: a shared policy or custom hours on their profile. Assignments take effect immediately. Create and edit shared policy contents in the dashboard; use the API to list policies, read a user's hours, assign or unassign users, and set or remove custom hours. The Connecteam agent uses this surface to help admins set expected hours during setup.

📘

One configuration per user

Shared policy or custom hours, never both. Assigning a shared policy replaces custom hours. Setting custom hours replaces a shared assignment.

---

Available Endpoints

Pay Rule Policies

Scheduling Rule Policies

Working Hours Policies

👍

Start with the family guide

Curl examples, field tables, and errors live on Pay Rule Policies, Scheduling Rule Policies, and Working Hours Policies.

---

Authentication

All endpoints require authentication via API key or OAuth 2.0.

Required Scopes

🚧

Plan limitations

Pay rules need the Time Clock API. Scheduling rules and working hours need the Schedule API. Working hours also need Regular Working Hours enabled on the account.

---

Use Cases

Onboarding New Employees

Automatically assign new hires to the appropriate pay rule policy (with an effective date), scheduling rule policy, and working hours policy based on their role, location, or department. The Connecteam agent can do the same during first-time setup.

Policy Updates

When compensation rules change, bulk-update pay rule assignments with a new effective date. When labor constraints change, assign employees to a different scheduling rule policy immediately.

Department Transfers

When employees transfer, update their pay rule policy, scheduling rule policy, and working hours so payroll and Job Schedule stay in sync.

Compliance lookup

Answer which scheduling rules apply to an employee, including custom profile rules, without opening the dashboard.

Agent-assisted setup

The Connecteam agent uses these endpoints to look up existing policies and attach people during account or employee setup, so admins do not have to walk through the dashboard by hand.

📘

Same surface as the agent

If you are building an integration, you are calling the same endpoints the Connecteam agent uses during setup. List policies first, then assign.

---

Guide Pages

---

API Reference