# Deputy Roster API

**Canonical:** https://apis.io/apis/deputy/deputy-roster-api/  
**Provider:** Deputy — https://apis.io/providers/deputy/  
**Base URL:** https://{install}.{geo}.deputy.com/api/v1  
**Documentation:** https://developer.deputy.com/deputy-docs

Deputy Roster API is one of 217 APIs that [Deputy](https://apis.io/providers/deputy/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 28 JSON Schema definitions. Tagged areas include Roster. The published artifact set on APIs.io includes an OpenAPI specification and 28 JSON Schemas.

V1 /my/roster/* endpoints

## Operations (60 of 68)

| Method | Path | Summary |
|---|---|---|
| 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 |

…and 8 more operations. They are listed in full on the page.

## Machine-readable artifacts (29)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/openapi/deputy-roster-api-openapi.yml
- **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

## Other Deputy APIs (12)

- [Deputy Public API](https://apis.io/apis/deputy/public-api/)
- [Deputy Access Management Employee API](https://apis.io/apis/deputy/deputy-access-management-employee-api/)
- [Deputy Access Management Employee Role API](https://apis.io/apis/deputy/deputy-access-management-employee-role-api/)
- [Deputy Access Management Employee Role History API](https://apis.io/apis/deputy/deputy-access-management-employee-role-history-api/)
- [Deputy Access Management Privilege Hierarchy API](https://apis.io/apis/deputy/deputy-access-management-privilege-hierarchy-api/)
- [Deputy Access Management Role API](https://apis.io/apis/deputy/deputy-access-management-role-api/)
- [Deputy Account Stats API](https://apis.io/apis/deputy/deputy-account-stats-api/)
- [Deputy Add Entitlement To Employees API](https://apis.io/apis/deputy/deputy-add-entitlement-to-employees-api/)
- [Deputy Address API](https://apis.io/apis/deputy/deputy-address-api/)
- [Deputy Agreed Hour API](https://apis.io/apis/deputy/deputy-agreed-hour-api/)
- [Deputy AI Assistant API](https://apis.io/apis/deputy/deputy-ai-assistant-api/)
- [Deputy Area Management API](https://apis.io/apis/deputy/deputy-area-management-api/)

## Tags

Roster

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/deputy/deputy-roster-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/deputy/.