Developer PortalDocsAPI Reference

DOCUMENTATION

Getting Started With The APIPostman CollectionTechnical Overview
Official SDKs

CHANGES

Changelog
New Legacy Report Field Map EndpointAPI Reference Sections Merged: AlertsAlert Template IDs Returned as IntegersLegacy Create Time Tracking Project Endpoint Marked DeprecatedNew Timesheet, Clock Entry, and Hour Entry EndpointsNew Legacy Report ID Map EndpointEmployee Table and Time Off Policy v1 Endpoints Marked DeprecatedNew Shift Assessments EndpointAPI Reference Sections Renamed: Change Tracking & Employee TablesNew Shift Differential Endpoints (Time Tracking)New Schedule PDF EndpointNew Employee Verification Record Update EndpointNew Scheduling EndpointsNew Employee Verification Integration and Lifecycle Email EndpointsNew Employee Verification Records EndpointNew Onboarding Experience and New Hire Widget EndpointsNew Hire Packet Delivery EndpointsNew Currency Conversion Rates EndpointNew Hire Packet Management EndpointsNew Country and Timezone EndpointsNew Industries EndpointNew Hire Packet Read EndpointsNew Break Policy Suggestions EndpointNew Compensation Planning Administration and Approval EndpointsNew Province and Timezone EndpointsNew Total Rewards EndpointsNew Delete Employee EndpointNew Compensation Planning Cycle and Budget EndpointsNew Compensation Tools and Equity Settings EndpointsNew Company Properties and Currency Type EndpointsNew Pay Grades & Bands Write EndpointsNew Alert Template and Configuration EndpointsNew Bank Holidays EndpointNew Pay Grades & Bands Read EndpointsTime Tracking Project and Task Endpoints Added to the Public API ReferenceNew Company Equity Settings EndpointNew Compensation Planning Read EndpointsNew Company Industry Codes EndpointNew Company Information EndpointNew Get Data from Dataset v2 EndpointNew Compensation Benchmarking EndpointsNew Company Display Name EndpointGet Data from Dataset v1 Marked DeprecatedNew Locations EndpointsDataset Discovery v1 Endpoints Marked DeprecatedLegacy Report Endpoints Marked DeprecatedNew Timezones EndpointNew Company Profile Integrations EndpointNew Webhook Post Fields EndpointNew Meal & Rest Breaks Endpoints (Time Tracking)Best Practice: Always Send Credentials With API RequestsNew Benefits EndpointsNew Dataset Field Options v1.2 Endpoint
New List Datasets v1.2 EndpointNew Dataset Fields v1.2 EndpointNew List Employees EndpointWebhooks for Custom FieldsNew Country and Province EndpointsWebhooks EnhancementsWebhook Scheduling and Rate Limiting Features RemovedWebhook Fields RemovedAPI Routing CentralizationLegacy Login Endpoint Marked DeprecatedTime Tracking Project Endpoint Removed from the Public API ReferenceNew Goals Aggregate v1.1 and v1.2 EndpointsSelf-Registration Now Available for Developer PortalNew Applications No Longer Support `oidcLogin`Get Goals Aggregate v1 Marked DeprecatedOlder Goal Endpoint Versions Marked DeprecatedOAuth 2.0 Now Supported for API AuthenticationNew Employee Photo EndpointRestricting Access to Email Addresses in the `/v1/meta/users/` Endpoint to Admin Users Only

FEEDBACK

API SupportGive API Feedback
Changelog2025

Time Tracking Project Endpoint Removed from the Public API Reference

We removed the following endpoint from the public API reference:

  • Create Time Tracking Project (POST /api/v1/time-tracking/projects)

Legacy Login Endpoint Marked Deprecated

Previous Page

New Goals Aggregate v1.1 and v1.2 Endpoints

Next Page