Developer Portal Docs API Reference

DOCUMENTATION

Getting Started With The API Postman Collection Technical Overview

CHANGES

New Legacy Report Field Map Endpoint API Reference Sections Merged: Alerts Alert Template IDs Returned as Integers Legacy Create Time Tracking Project Endpoint Marked Deprecated New Timesheet, Clock Entry, and Hour Entry Endpoints New Legacy Report ID Map Endpoint Employee Table and Time Off Policy v1 Endpoints Marked Deprecated New Shift Assessments Endpoint API Reference Sections Renamed: Change Tracking & Employee Tables New Shift Differential Endpoints (Time Tracking)New Schedule PDF Endpoint New Employee Verification Record Update Endpoint New Scheduling Endpoints New Employee Verification Integration and Lifecycle Email Endpoints New Employee Verification Records Endpoint New Onboarding Experience and New Hire Widget Endpoints New Hire Packet Delivery Endpoints New Currency Conversion Rates Endpoint New Hire Packet Management Endpoints New Country and Timezone Endpoints New Industries Endpoint New Hire Packet Read Endpoints New Break Policy Suggestions Endpoint New Compensation Planning Administration and Approval Endpoints New Province and Timezone Endpoints New Total Rewards Endpoints New Delete Employee Endpoint New Compensation Planning Cycle and Budget Endpoints New Compensation Tools and Equity Settings Endpoints New Company Properties and Currency Type Endpoints New Pay Grades & Bands Write Endpoints New Alert Template and Configuration Endpoints New Bank Holidays Endpoint New Pay Grades & Bands Read Endpoints Time Tracking Project and Task Endpoints Added to the Public API Reference New Company Equity Settings Endpoint New Compensation Planning Read Endpoints New Company Industry Codes Endpoint New Company Information Endpoint New Get Data from Dataset v2 Endpoint New Compensation Benchmarking Endpoints New Company Display Name Endpoint Get Data from Dataset v1 Marked Deprecated New Locations Endpoints Dataset Discovery v1 Endpoints Marked Deprecated Legacy Report Endpoints Marked Deprecated New Timezones Endpoint New Company Profile Integrations Endpoint New Webhook Post Fields Endpoint New Meal & Rest Breaks Endpoints (Time Tracking)Best Practice: Always Send Credentials With API Requests New Benefits Endpoints New Dataset Field Options v1.2 Endpoint

New List Datasets v1.2 Endpoint New Dataset Fields v1.2 Endpoint New List Employees Endpoint Webhooks for Custom Fields New Country and Province Endpoints Webhooks Enhancements Webhook Scheduling and Rate Limiting Features Removed Webhook Fields Removed API Routing Centralization Legacy Login Endpoint Marked Deprecated Time Tracking Project Endpoint Removed from the Public API Reference New Goals Aggregate v1.1 and v1.2 Endpoints Self-Registration Now Available for Developer Portal New Applications No Longer Support `oidcLogin`Get Goals Aggregate v1 Marked Deprecated Older Goal Endpoint Versions Marked Deprecated OAuth 2.0 Now Supported for API Authentication New Employee Photo Endpoint Restricting Access to Email Addresses in the `/v1/meta/users/` Endpoint to Admin Users Only

FEEDBACK

API Support Give API Feedback

Changelog2025

New Employee Photo Endpoint

We added the following public API endpoint for retrieving employee photos:

Get Employee Photo (GET /api/v1/employees/{employeeId}/photo/{size})

Review the linked documentation for more information.

OAuth 2.0 Now Supported for API Authentication

Previous Page

Restricting Access to Email Addresses in the `/v1/meta/users/` Endpoint to Admin Users Only

Next Page