Deputy API

Name: Deputy API
Brand: Deputy API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentHR recruitingEmployee Managementbearer27 EndpointsREST

For Agents

Manage Deputy employees, rosters, timesheets, leave, locations, departments, and sales metrics, plus retrieve the signed-in user's own schedule.

Install Jentic One Beta

Connect the Deputy API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Deputy API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Deputy API.

Add, update, terminate, and re-activate employees through the supervise/employee endpoints

Publish rosters and list scheduled shifts via /v1/supervise/roster endpoints

Start and end timesheets to drive a clock-on and clock-off flow

GET STARTED

Start building with Deputy API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Deputy API for, with concrete tasks.

★ Employee Onboarding Automation

Push new joiners from an HRIS into Deputy by calling POST /v1/supervise/employee, then send the welcome invite via POST /v1/supervise/employee/{employeeid}/invite. Termination flows mirror this with the terminate endpoint, keeping Deputy in sync with the HR source of truth without manual data entry.

Call POST /v1/supervise/employee with the new hire details, then POST /v1/supervise/employee/{employeeid}/invite to send the app invite.

Roster Publishing Workflow

Build draft schedules in an external planner and publish them into Deputy via POST /v1/supervise/roster/publish, using GET /v1/supervise/roster to confirm the published shifts. This pattern is common for operations teams that prefer a custom forecasting tool but still want Deputy as the system of record for shifts.

Call POST /v1/supervise/roster/publish with the prepared schedule payload, then GET /v1/supervise/roster to verify the publish.

Time Clock for Custom Apps

Power a branded clock-on and clock-off experience by calling POST /v1/supervise/timesheet/start and POST /v1/supervise/timesheet/end from a kiosk app. GET /v1/supervise/timesheet/{timesheetid}/details closes the loop for confirmation and audit, replacing the default Deputy app where the use case demands a custom UI.

When the employee taps clock on, call POST /v1/supervise/timesheet/start with their employee id; on tap clock off, call POST /v1/supervise/timesheet/end.

Sales-Driven Forecasting

Feed sales metrics from the POS into Deputy via POST /v2/metrics, and pull historical data with GET /v2/metrics/raw to evaluate roster effectiveness. This closes the loop between revenue and labour planning for retail and hospitality operators.

Each evening, push the day's sales totals via POST /v2/metrics keyed by location id.

AI Agent Integration via Jentic

An ops agent can use Jentic to handle one-off Deputy tasks like terminating an employee, publishing a roster, or pulling the signed-in user's schedule for a question. Jentic resolves the Bearer token and the install/geo base URL parameters, so the agent does not need to manage tenant-specific URL building.

Use Jentic to search for 'publish a deputy roster', load POST /v1/supervise/roster/publish, and execute it with the prepared schedule.

Key Endpoints

27 endpoints — jentic publishes the only available openapi specification for deputy api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/v1/supervise/employee

Add a new employee

POST

/v1/supervise/employee/{employeeid}/invite

Invite an employee to Deputy

POST

/v1/supervise/roster/publish

Publish a roster

POST

/v1/supervise/timesheet/start

Start a timesheet (clock on)

POST

/v1/supervise/timesheet/end

End a timesheet (clock off)

POST

/v1/supervise/leave

Add leave for an employee

POST

/v2/metrics

Add a sales metric

GET

/v1/my/roster

Get my roster

POST

/v1/supervise/employee

Add a new employee

POST

/v1/supervise/employee/{employeeid}/invite

Invite an employee to Deputy

POST

/v1/supervise/roster/publish

Publish a roster

POST

/v1/supervise/timesheet/start

Start a timesheet (clock on)

POST

/v1/supervise/timesheet/end

End a timesheet (clock off)

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Deputy bearer token is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'publish a Deputy roster' or 'clock an employee on', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without reading Deputy's documentation.

Time to first call

FAQs

Specific to using Deputy API through Jentic.

Why is there no official OpenAPI spec for Deputy API?

Deputy does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Deputy API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

What authentication does the Deputy API use?

The Deputy API uses HTTP Bearer token authentication. Tokens are issued from your Deputy install and passed in the Authorization header. Through Jentic, tokens are stored encrypted in the vault and never exposed to the agent.

Can I publish a roster with the Deputy API?

Yes. POST /v1/supervise/roster/publish publishes a prepared schedule, and GET /v1/supervise/roster lists existing rosters so you can confirm what shifts are now live.

How do I clock an employee on and off through the Deputy API?

Call POST /v1/supervise/timesheet/start to clock the employee on and POST /v1/supervise/timesheet/end to clock them off. GET /v1/supervise/timesheet/{timesheetid}/details lets you fetch the resulting timesheet for review.

What is the base URL for the Deputy API?

Deputy uses a tenant-specific URL of the form https://{install}.{geo}.deputy.com/api, where install is your Deputy subdomain and geo is the regional cluster (for example au, na, or eu). Both placeholders must be substituted before calling any endpoint.

How do I add a new employee through Jentic?

Run `pip install jentic`, search for 'add a deputy employee', execute POST /v1/supervise/employee with the new hire payload, and follow up with POST /v1/supervise/employee/{employeeid}/invite. Jentic uses the stored Bearer token for both calls.

Can I limit what my agent is allowed to do with the Deputy API?

Yes. Because you run Jentic One yourself, you decide which Deputy operations the agent may call and which credential it uses, so you can grant only read-only actions like fetching its own roster (GET /v1/my/roster) or clocking a timesheet on and off (POST /v1/supervise/timesheet/start and /end). Higher-impact operations such as publishing a roster (POST /v1/supervise/roster/publish), creating or terminating employees (POST /v1/supervise/employee), or pushing sales metrics (POST /v2/metrics) are available to the agent only if you add them. The Deputy bearer token is held by your own instance and injected at execution time, so the agent never sees it.

Deputy API

Connect the Deputy API to your agent

Capabilities

Start building with Deputy API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs