Deputy

Deputy Roster API

V1 /my/roster/* endpoints

GitHub OpenAPI
Business capability
Human Capital Management BC-300

Operations 68

GET /my/roster/bids GET Roster / bids #
POST /my/roster/bids/request POST Roster / request #
POST /my/roster/bids/withdraw POST Roster / withdraw #
POST /my/roster/confirm POST Roster / confirm #
GET /my/roster/open GET Roster / open #
POST /my/roster/open POST Roster / open #
GET /my/roster/open/({startDate})(/{endDate})/{maxWaitTime} GET Roster / :maxWaitTime)? #
GET /my/roster/publish/allow/({numOfRostersToPublish}) GET Roster / (:numOfRostersToPublish) #
GET /my/roster/publish/count GET Roster / count #
GET /my/roster/startTimestamp/{startTimestamp}/reverse/{reverse}/limit/{limit} GET Roster / :limit #
GET /my/roster/swap/{startDate}/{endDate} GET Roster / :endDate)? #
GET /my/roster/{id} GET Roster / :id #
POST /my/roster/{id}/offer POST Roster / offer #
POST /my/roster/{id}/offer/cancel POST Roster / cancel #
GET /my/roster/{id}/offer/getrecommendation GET Roster / getrecommendation #
GET /my/roster/{id}/offer/status GET Roster / status #
POST /my/roster/{id}/swap/{action} POST Roster / :action #
GET /my/roster/{id}/swapdetails GET Roster / swapdetails #
GET /my/roster/{startDate}/{endDate} GET Roster / :endDate)? #
GET /resource/Roster List Roster records #
POST /resource/Roster Create a Roster #
PUT /resource/Roster Create a Roster #
POST /resource/Roster/BULK Bulk create/update Roster #
GET /resource/Roster/INFO Get field metadata for Roster #
POST /resource/Roster/PREDICT Predict-match a Roster record #
POST /resource/Roster/QUERY Search Roster #
GET /resource/Roster/{id} Get a Roster by id #
POST /resource/Roster/{id} Update a Roster #
PUT /resource/Roster/{id} Update a Roster #
DELETE /resource/Roster/{id} Delete a Roster #
GET /resource/Roster/{id}/COMMENTS List comments on a Roster #
POST /resource/Roster/{id}/COMMENTS Add a comment to a Roster #
DELETE /resource/Roster/{id}/COMMENTS/{commentId} Delete a comment on a Roster #
GET /resource/Roster/{id}/HISTORY Get change history for a Roster #
GET /resource/Roster/{id}/HISTORY/travel/{timestamp} Get a Roster as it existed at a prior time #
POST /supervise/roster Create or update Roster #
POST /supervise/roster/autobuild POST Roster / autobuild #
POST /supervise/roster/autobuildfromagreedhours POST Roster / autobuildfromagreedhours #
POST /supervise/roster/autobuildfromgfe POST Roster / autobuildfromgfe #
POST /supervise/roster/autofill POST Roster / autofill #
POST /supervise/roster/bid/approve POST Roster / approve #
POST /supervise/roster/cancelautofill POST Roster / cancelautofill #
GET /supervise/roster/checkautobuild/{jobKey} GET Roster / :jobKey #
POST /supervise/roster/checkautobuildfromagreedhours/{jobKey} POST Roster / :jobKey #
POST /supervise/roster/checkautobuildfromgfe/{jobKey} POST Roster / :jobKey #
GET /supervise/roster/checkautofill/{jobKey} GET Roster / :jobKey #
POST /supervise/roster/connect-info POST Roster / connect info #
POST /supervise/roster/copy POST Roster / copy #
POST /supervise/roster/copy/batch POST Roster / batch #
POST /supervise/roster/discard POST Roster / discard #
GET /supervise/roster/notifymanager/{id} GET Roster / :id #
GET /supervise/roster/pending-approval-swap-details/{id} GET Roster / :id #
POST /supervise/roster/publish POST Roster / publish #
POST /supervise/roster/shift/setup POST Roster / setup #
POST /supervise/roster/swap/{action} POST Roster / :action #
GET /supervise/roster/swap/{startDate}/{endDate} GET Roster / :endDate)? #
POST /supervise/roster/systemtemplate/copy POST Roster / copy #
GET /supervise/roster/systemtemplate/list/{intMode} GET Roster / :intMode #
POST /supervise/roster/template/{companyId}/{action} POST Roster / :action #
DELETE /supervise/roster/template/{templateId} DELETE Roster / :templateId #
GET /supervise/roster/{date} GET Roster / (:date)? #
GET /supervise/roster/{date}/{intCompanyId} GET Roster / :intCompanyId #
GET /supervise/roster/{date}/{intCompanyId}/{limit}/{offset}/{fetchOpen} GET Roster / :fetchOpen)? #
GET /supervise/roster/{id} GET Roster / :id #
GET /supervise/roster/{id}/bids GET Roster / bids #
GET /supervise/roster/{id}/swapdetails GET Roster / swapdetails #
GET /supervise/roster/{strStartYMD}/{intCompanyId}/{strEndYMD} GET Roster / :strEndYMD #
GET /tsa/v2/rosters/{rosterId} Get Roster #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/openapi/deputy-roster-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-roster-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-roster-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Deputy Roster API
  version: '1.0'
  description: 'Operations tagged Roster across 4 of this provider''s published API definitions: deputy-v1-my-api-openapi.yml, deputy-v1-resource-api-openapi.yml, deputy-v1-supervise-api-openapi.yml, deputy-v2-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{subdomain}.{region}.deputy.com/api/v1
  description: Deputy tenant
  variables:
    subdomain:
      default: your-subdomain
    region:
      default: deputy
      enum:
      - au
      - eu
      - na
      - deputy
- 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)'
tags:


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