Deputy

Deputy Shifts API

The Shifts API from Deputy — 34 operation(s) for shifts.

GitHub OpenAPI
Business capability
Human Capital Management BC-300

Operations 37

GET /management/v2/shifts Retrieve list of shifts #
POST /management/v2/shifts Create a new shift #
POST /management/v2/shifts/bids:status decline a shift #
GET /management/v2/shifts/copy/job/{jobId} Get copy status #
POST /management/v2/shifts/open/pending-approvals Get pending approval open shifts #
GET /management/v2/shifts/{id} Retrieve shift data by given Id #
DELETE /management/v2/shifts/{id} Delete an existing shift #
PUT /management/v2/shifts/{id} Update an existing shift #
GET /management/v2/shifts/{id}/bids:statusCounts get the bid count for each status #
GET /management/v2/shifts/{id}/history Get shift history #
GET /management/v2/shifts/{id}/log Get shift log new #
POST /management/v2/shifts/{id}/open:deleteInvitations delete open shift invitations #
GET /management/v2/shifts/{id}/open:invitations get open shift invitation list #
POST /management/v2/shifts/{id}/open:status Accept/decline an open shift #
GET /management/v2/shifts/{id}/open:statusCounts get count for each status in find replacement, open shift #
GET /management/v2/shifts/{id}/permissions Get shift permissions #
POST /management/v2/shifts/{id}/suggestions Get suggestions for a shift #
POST /management/v2/shifts/{id}:calculateCost Get potential costs for a shift given a list of employee ids #
GET /management/v2/shifts:aggregated Retrieve an aggregated list of shifts #
POST /management/v2/shifts:autobuild Auto-build shifts (Asynchronous) #
POST /management/v2/shifts:autofill Auto-fill shifts (Asynchronous) #
POST /management/v2/shifts:bulk Bulk create or update shifts (asynchronous) #
POST /management/v2/shifts:bulkDefaults Get default shifts for many dates and areas #
POST /management/v2/shifts:bulkDelete Bulk delete shifts (asynchronous) #
POST /management/v2/shifts:bulkPatch Bulk patch shifts (asynchronous) #
POST /management/v2/shifts:bulkUpdate Bulk update shifts (asynchronous) #
POST /management/v2/shifts:copy Copy shifts (asynchronous) #
POST /management/v2/shifts:defaults Get default shifts #
POST /management/v2/shifts:delete Delete shift #
POST /management/v2/shifts:getRosters manager to get rosters; replacement of v1 getRosters #
POST /management/v2/shifts:open Get open shifts #
POST /management/v2/shifts:publish Publish shifts (asynchronous) #
POST /management/v2/shifts:resave Resave shifts (Asynchronous) #
POST /management/v2/shifts:split Split #
POST /management/v2/shifts:validate Validate external shifts #
POST /schedule/v2/me/shifts:search My schedule #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/openapi/deputy-shifts-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-addanemployee-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-createa-department-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-addleaveforaemployee-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-createamemo-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-add-new-workplace-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-setawardforemployee-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-custom-field-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-timesheet-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-employee-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-pay-rules-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-roster-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-employee-agreement-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-tenanttimesheetv2model-timesheet-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-pay-comparison-submit-report-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-v2model-leave-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-v2model-employment-contracts-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-copy-request-copy-request-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-v2model-area-profile-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchfor-employment-contract-leave-rules-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employee-agreement-history-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employee-availability-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforacustomfielddataentry-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employment-condition-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employment-contract-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-hr-export-export-hr-bulk-data-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-user-info-get-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-hr-export-export-hr-data-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-hr-export-export-hr-pay-details-data-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/deputy:deputy-shifts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

deputy-shifts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Deputy V2 Shifts API
  version: '1.0'
  description: Filtered to publicly-authenticated routes only (APIAuthenticator). Scoped-OAuth routes and internal JWT routes are excluded — see the separate "Deputy V2 Scoped API" spec for scoped endpoints.
servers:
- url: https://{subdomain}.{region}.deputy.com/api
  description: Deputy tenant
  variables:
    subdomain:
      default: your-subdomain
      description: Your Deputy tenant subdomain
    region:
      default: deputy
      enum:
      - au
      - eu
      - na
      - deputy
      description: 'Deputy region: au, eu, na, or deputy (AU default)'
security:
- ApiToken: []
tags:


# --- truncated at 32 KB (147 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/openapi/deputy-shifts-api-openapi.yml