Deputy - Stackone

Getting Started

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · OAuth 2.0

OAuth 2.0 is the recommended authentication method for Deputy.

Optionally, configure receiving Events for Deputy into StackOne.

Webhooks setup

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · OAuth 2.0

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

49 actions

Action

Description

List Locations

Get all locations (companies) in the Deputy installation

Create Location

Create a new location in Deputy

Update Location

Update an existing location in Deputy

Delete Location

Delete a location in Deputy

Add New Workplace

Add a new workplace/location to Deputy

List Employees

Get details for all employees

Search Employees

Search and filter employees by criteria

Get Employee

Get details for an employee by ID

Create Employee

Add an employee

Update Employee

Update an existing employee

Add Location To Employee

Add a location against an employee

Remove Location From Employee

Remove a location from an employee

Terminate Employee

Terminate an employee

Activate Employee

Re-activate a terminated employee

Invite Employee

Invite employee to Deputy

Get Employee Shift Status

Check whether an employee is currently clocked on, on break, or off shift

Post A Journal

Post a journal entry for an employee

Get Employee Unavailability

Get unavailability details for an employee

Add Employee Unavailability

Add unavailability details for an employee

List Employee Agreements

Get all employee agreements

Search Employment Contracts

Search for employment contracts using query filters

Search Employment Contract Leave Rules

Search for employment contract leave rules

List Employee Roles

Get all employee roles

List Employee Workplaces

Get all employee workplace records

Search Employee History

Search for employee history records

List Employee Availability

Get all employee availability records

List Employee Appraisals

Get all employee appraisal records

List Employee Agreement History

Get all employee agreement history records

List Employment Conditions

Get all employment condition records

Start Timesheet (Clock On)

Start an employee’s timesheet (Clock On)

Stop Timesheet (Clock Off)

Stop an employee’s timesheet (Clock Off)

Pause/Unpause Timesheet

Pause or unpause an employee’s timesheet (take a break/finish break)

View Timesheet Details

View a timesheet by ID

Get Recent Rosters

Get rosters from last 12 hours and forward 36 hours

Copy Rosters

Copy rosters from one date range to another

Publish Rosters

Publish rosters to make them visible to employees

Discard Rosters

Discard unpublished rosters

List Operational Units

Get all operational units (areas/departments)

Create Operational Unit

Create a new operational unit (department/area)

Create Multiple Operational Units

Create multiple operational units (departments/areas) at once

Update Operational Unit

Update an existing operational unit

Delete Operational Unit

Delete an operational unit

List Awards Library

Get awards library list

Get Agreed Hours By Employee ID

Get agreed hours for a specific employee

Create Memo

Create a memo in Deputy

Retrieve Sales Data

Get sales metrics data

List Categories

Get all categories

List Custom Fields

Get all custom field definitions

List Events

Get all events

Events

​Getting Started